VLAN Trunking Dec 18, 2023
An explanation of how to trunk vlans with the CLI so servers can have access to more than their native VLANs
diff --git a/article/openAPI/index.html b/article/openAPI/index.html
new file mode 100644
index 0000000000..2fa54b478f
--- /dev/null
+++ b/article/openAPI/index.html
@@ -0,0 +1,239 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/index.xml b/index.xml
index d282d334a1..4f3835d16b 100644
--- a/index.xml
+++ b/index.xml
@@ -5,7 +5,7 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Open API Definitions for SLDN
+ Introducing OpenAPI spec sheet for SLDN api +Open API
+We now have tenative support for an Open API spec. You can download it from SLDN
+Due to the way SLDN is designed, the spec sheet is fairly lengthy and a bit complicated, but perhaps it will be useful.
+Generation
+If you are interested in how the file is generated, check out bin/generateOpenAPI.py
+OpenAPI CLI Can be used to generate HTML or whatever else from this document.
+$> mkdir generated
+$> wget https://sldn.softlayer.com/static/openapi/sl_openapi.json
+$> java -jar openapi-generator-cli.jar generate -g html -i sl_openapi.json -o generated/ --skip-operation-example
+You will need the --skip-operation-example option otherwise openapi-generator-cli will run out of memory building SLDN objects.
+
+
+
+
+
+
+
+ Warning: If you remove the EU Supported account flag, you are removing the restriction that limits Processing activities to EU personnel.
", + "summary": "Turn off the EU Supported account flag.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/disableEuSupport/" + }, + "operationId": "SoftLayer_Account::disableEuSupport", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "null" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/disableVpnConfigRequiresVpnManageAttribute": { + "get": { + "description": "Disables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account. If the attribute does not exist for the account, it will be created and set to false. ", + "summary": "Disable the VPN Config Requires VPN Manage attribute, creating it if necessary.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/disableVpnConfigRequiresVpnManageAttribute/" + }, + "operationId": "SoftLayer_Account::disableVpnConfigRequiresVpnManageAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "null" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/editAccount": { + "post": { + "description": "This method will edit the account's information. Pass in a SoftLayer_Account template with the fields to be modified. Certain changes to the account will automatically create a ticket for manual review. This will be returned with the SoftLayer_Container_Account_Update_Response.The following fields are editable:
- companyName
- firstName
- lastName
- address1
- address2
- city
- state
- country
- postalCode
- officePhone
- alternatePhone
- faxPhone
- abuseEmails.email
- billingInfo.vatId
If you select the EU Supported option, the most common Support issues will be limited to IBM Cloud staff located in the EU. In the event your issue requires non-EU expert assistance, it will be reviewed and approval given prior to any non-EU intervention. Additionally, in order to support and update the services, cross-border Processing of your data may still occur. Please ensure you take the necessary actions to allow this Processing, as detailed in the Cloud Service Terms. A standard Data Processing Addendum is available here.
\n\nImportant note (you will only see this once): Orders using the API will proceed without additional notifications. The terms related to selecting products, services, or locations outside the EU apply to API orders. Users you create and API keys you generate will have the ability to order products, services, and locations outside of the EU. It is your responsibility to educate anyone you grant access to your account on the consequences and requirements if they make a selection that is not in the EU Supported option. In order to meet EU Supported requirements, the current PPTP VPN solution will no longer be offered or supported.
\n\nIf PPTP has been selected as an option for any users in your account by itself (or in combination with another VPN offering), you will need to disable PPTP before selecting the EU Supported account feature. For more information on VPN changes, click here.
", + "summary": "Turn on the EU Supported account flag.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/enableEuSupport/" + }, + "operationId": "SoftLayer_Account::enableEuSupport", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "null" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/enableVpnConfigRequiresVpnManageAttribute": { + "get": { + "description": "Enables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account. If the attribute does not exist for the account, it will be created and set to true. ", + "summary": "Enable the VPN Config Requires VPN Manage attribute, creating it if necessary.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/enableVpnConfigRequiresVpnManageAttribute/" + }, + "operationId": "SoftLayer_Account::enableVpnConfigRequiresVpnManageAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "null" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAccountBackupHistory": { + "post": { + "description": "This method returns an array of SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails objects for the given start and end dates. Start and end dates should be be valid ISO 8601 dates. The backupStatus can be one of null, 'success', 'failed', or 'conflict'. The 'success' backupStatus returns jobs with a status of 'COMPLETED', the 'failed' backupStatus returns jobs with a status of 'FAILED', while the 'conflict' backupStatus will return jobs that are not 'COMPLETED' or 'FAILED'. ", + "summary": "This method provides a history of account backups.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAccountBackupHistory/" + }, + "operationId": "SoftLayer_Account::getAccountBackupHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getAccountBackupHistory::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getAccountBackupHistory::Parameters::Input", + "properties": { + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" + }, + "backupStatus": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getAccountTraitValue": { + "post": { + "description": "This method pulls an account trait by its key. ", + "summary": "Get the specific trait by its key", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAccountTraitValue/" + }, + "operationId": "SoftLayer_Account::getAccountTraitValue", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getAccountTraitValue::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getAccountTraitValue::Parameters::Input", + "properties": { + "keyName": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getActiveOutletPackages": { + "get": { + "description": "This is deprecated and will not return any results. ", + "summary": "DEPRECATED. This method will return nothing.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveOutletPackages/" + }, + "operationId": "SoftLayer_Account::getActiveOutletPackages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActivePackages": { + "get": { + "description": "This method will return the [[SoftLayer_Product_Package]] objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [[SoftLayer_Product_Package/getCategories|getCategories]] or [[SoftLayer_Product_Package/getItems|getItems]] for more information. \n\nPackages that have been retired will not appear in this result set. ", + "summary": "Retrieve the active [[SoftLayer_Product_Package]] objects from which you can order a server, service or software. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActivePackages/" + }, + "operationId": "SoftLayer_Account::getActivePackages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActivePackagesByAttribute": { + "post": { + "description": "This method is deprecated and should not be used in production code. \n\nThis method will return the [[SoftLayer_Product_Package]] objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software filtered by an attribute type associated with the package. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [[SoftLayer_Product_Package/getCategories|getCategories]] or [[SoftLayer_Product_Package/getItems|getItems]] for more information. ", + "summary": "[DEPRECATED] Retrieve the active [[SoftLayer_Product_Package]] objects from which you can order a server, service or software filtered by an attribute type ([[SoftLayer_Product_Package_Attribute_Type]]) on the package. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActivePackagesByAttribute/" + }, + "operationId": "SoftLayer_Account::getActivePackagesByAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getActivePackagesByAttribute::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getActivePackagesByAttribute::Parameters::Input", + "properties": { + "attributeKeyName": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getActivePrivateHostedCloudPackages": { + "get": { + "description": "[DEPRECATED] This method pulls all the active private hosted cloud packages. This will give you a basic description of the packages that are currently active and from which you can order private hosted cloud configurations. ", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActivePrivateHostedCloudPackages/" + }, + "operationId": "SoftLayer_Account::getActivePrivateHostedCloudPackages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAlternateCreditCardData": { + "get": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAlternateCreditCardData/" + }, + "operationId": "SoftLayer_Account::getAlternateCreditCardData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Account_Payment_Method_CreditCard" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAttributeByType": { + "post": { + "description": "Retrieve a single [[SoftLayer_Account_Attribute]] record by its [[SoftLayer_Account_Attribute_Type|types's]] key name. ", + "summary": "Retrieve an account attribute by type key name.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAttributeByType/" + }, + "operationId": "SoftLayer_Account::getAttributeByType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getAttributeByType::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getAttributeByType::Parameters::Input", + "properties": { + "attributeType": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getAuxiliaryNotifications": { + "get": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAuxiliaryNotifications/" + }, + "operationId": "SoftLayer_Account::getAuxiliaryNotifications", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Message" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate": { + "post": { + "description": "Returns the average disk space usage for all archive repositories. ", + "summary": "Returns the average disk usage for all archive repositories for the timeframe based on the parameters provided. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate/" + }, + "operationId": "SoftLayer_Account::getAverageArchiveUsageMetricDataByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getAverageArchiveUsageMetricDataByDate::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getAverageArchiveUsageMetricDataByDate::Parameters::Input", + "properties": { + "startDateTime": { + "type": "string" + }, + "endDateTime": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getAveragePublicUsageMetricDataByDate": { + "post": { + "description": "Returns the average disk space usage for all public repositories. ", + "summary": "Returns the average disk usage for all public repositories for the timeframe based on the parameters provided. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate/" + }, + "operationId": "SoftLayer_Account::getAveragePublicUsageMetricDataByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getAveragePublicUsageMetricDataByDate::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getAveragePublicUsageMetricDataByDate::Parameters::Input", + "properties": { + "startDateTime": { + "type": "string" + }, + "endDateTime": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getBandwidthList": { + "post": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBandwidthList/" + }, + "operationId": "SoftLayer_Account::getBandwidthList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_Usage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getBandwidthList::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getBandwidthList::Parameters::Input", + "properties": { + "networkType": { + "type": "string" + }, + "direction": { + "type": "string" + }, + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" + }, + "serverIds": { + "type": "array", + "items": { + "type": "number" + } + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getCurrentUser": { + "get": { + "description": "Retrieve the user record of the user calling the SoftLayer API. ", + "summary": "Retrieve the current API user's record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getCurrentUser/" + }, + "operationId": "SoftLayer_Account::getCurrentUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getDedicatedHostsForImageTemplate": { + "post": { + "description": "This returns a collection of dedicated hosts that are valid for a given image template. ", + "summary": "Get a collection of dedicated hosts that are valid for a given image template. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getDedicatedHostsForImageTemplate/" + }, + "operationId": "SoftLayer_Account::getDedicatedHostsForImageTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_DedicatedHost" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getDedicatedHostsForImageTemplate::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getDedicatedHostsForImageTemplate::Parameters::Input", + "properties": { + "imageTemplateId": { + "type": "number" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getFlexibleCreditProgramInfo": { + "post": { + "description": "[DEPRECATED] Please use SoftLayer_Account::getFlexibleCreditProgramsInfo. \n\nThis method will return a [[SoftLayer_Container_Account_Discount_Program]] object containing the Flexible Credit Program information for this account. To be considered an active participant, the account must have an enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false. Please note that all discount amount entries are reported as pre-tax amounts and the legacy tax fields in the [[SoftLayer_Container_Account_Discount_Program]] are deprecated. ", + "summary": "[DEPRECATED] Please use SoftLayer_Account::getFlexibleCreditProgramsInfo. This is no longer an accurate representation of discounts. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getFlexibleCreditProgramInfo/" + }, + "operationId": "SoftLayer_Account::getFlexibleCreditProgramInfo", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Account_Discount_Program" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getFlexibleCreditProgramInfo::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getFlexibleCreditProgramInfo::Parameters::Input", + "properties": { + "forNextBillCycle": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getFlexibleCreditProgramsInfo": { + "post": { + "description": "This method will return a [[SoftLayer_Container_Account_Discount_Program_Collection]] object containing information on all of the Flexible Credit Programs your account is enrolled in. To be considered an active participant, the account must have at least one enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program_Collection object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false. Please note that all discount amount entries are reported as pre-tax amounts. ", + "summary": "This method retrieves information on all of your Flexible Credit Program enrollments for your account. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getFlexibleCreditProgramsInfo/" + }, + "operationId": "SoftLayer_Account::getFlexibleCreditProgramsInfo", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Account_Discount_Program_Collection" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getFlexibleCreditProgramsInfo::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getFlexibleCreditProgramsInfo::Parameters::Input", + "properties": { + "nextBillingCycleFlag": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getHardwarePools": { + "get": { + "description": "Return a collection of managed hardware pools.", + "summary": "Get a collection of managed hardware pools.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwarePools/" + }, + "operationId": "SoftLayer_Account::getHardwarePools", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Pool_Details" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLargestAllowedSubnetCidr": { + "post": { + "description": "Computes the number of available public secondary IP addresses, aligned to a subnet size. ", + "summary": "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. \n\n0 is returned if an overflow is detected. \n\nThe use of $locationId has been deprecated. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLargestAllowedSubnetCidr/" + }, + "operationId": "SoftLayer_Account::getLargestAllowedSubnetCidr", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getLargestAllowedSubnetCidr::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getLargestAllowedSubnetCidr::Parameters::Input", + "properties": { + "numberOfHosts": { + "type": "number" + }, + "locationId": { + "type": "number" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getNetAppActiveAccountLicenseKeys": { + "get": { + "description": "This returns a collection of active NetApp software account license keys.", + "summary": "Get a collection of active NetApp software account license keys.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetAppActiveAccountLicenseKeys/" + }, + "operationId": "SoftLayer_Account::getNetAppActiveAccountLicenseKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceExcel": { + "post": { + "description": "Return an account's next invoice in a Microsoft excel format. The \"next invoice\" is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.", + "summary": "Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceExcel/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceExcel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getNextInvoiceExcel::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getNextInvoiceExcel::Parameters::Input", + "properties": { + "documentCreateDate": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getNextInvoicePdf": { + "post": { + "description": "Return an account's next invoice in PDF format. The \"next invoice\" is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.", + "summary": "Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoicePdf/" + }, + "operationId": "SoftLayer_Account::getNextInvoicePdf", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getNextInvoicePdf::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getNextInvoicePdf::Parameters::Input", + "properties": { + "documentCreateDate": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getNextInvoicePdfDetailed": { + "post": { + "description": "Return an account's next invoice detailed portion in PDF format. The \"next invoice\" is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.", + "summary": "Retrieve the next billing period's detailed invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoicePdfDetailed/" + }, + "operationId": "SoftLayer_Account::getNextInvoicePdfDetailed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getNextInvoicePdfDetailed::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getNextInvoicePdfDetailed::Parameters::Input", + "properties": { + "documentCreateDate": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getNextInvoiceZeroFeeItemCounts": { + "get": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceZeroFeeItemCounts/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceZeroFeeItemCounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Item_Category_ZeroFee_Count" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Account object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Account service. You can only retrieve the account that your portal user is assigned to. ", + "summary": "Retrieve a SoftLayer_Account record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getObject/" + }, + "operationId": "SoftLayer_Account::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPendingCreditCardChangeRequestData": { + "get": { + "description": "Before being approved for general use, a credit card must be approved by a SoftLayer agent. Once a credit card change request has been either approved or denied, the change request will no longer appear in the list of pending change requests. This method will return a list of all pending change requests as well as a portion of the data from the original request. ", + "summary": "Retrieve details of all credit card change requests which have not been processed by a SoftLayer agent.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingCreditCardChangeRequestData/" + }, + "operationId": "SoftLayer_Account::getPendingCreditCardChangeRequestData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Account_Payment_Method_CreditCard" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getReferralPartnerCommissionForecast": { + "get": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getReferralPartnerCommissionForecast/" + }, + "operationId": "SoftLayer_Account::getReferralPartnerCommissionForecast", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Referral_Partner_Commission" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getReferralPartnerCommissionHistory": { + "get": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getReferralPartnerCommissionHistory/" + }, + "operationId": "SoftLayer_Account::getReferralPartnerCommissionHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Referral_Partner_Commission" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getReferralPartnerCommissionPending": { + "get": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getReferralPartnerCommissionPending/" + }, + "operationId": "SoftLayer_Account::getReferralPartnerCommissionPending", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Referral_Partner_Commission" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSharedBlockDeviceTemplateGroups": { + "get": { + "description": "This method returns the [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] objects that have been shared with this account ", + "summary": "Get the collection of template group objects that have been shared with this account.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSharedBlockDeviceTemplateGroups/" + }, + "operationId": "SoftLayer_Account::getSharedBlockDeviceTemplateGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getTechIncubatorProgramInfo": { + "post": { + "description": "This method will return a SoftLayer_Container_Account_Discount_Program object containing the Technology Incubator Program information for this account. To be considered an active participant, the account must have an enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false. ", + "summary": "This method retrieves the Technology Incubator Program information for your account. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getTechIncubatorProgramInfo/" + }, + "operationId": "SoftLayer_Account::getTechIncubatorProgramInfo", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Account_Discount_Program" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::getTechIncubatorProgramInfo::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::getTechIncubatorProgramInfo::Parameters::Input", + "properties": { + "forNextBillCycle": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getThirdPartyPoliciesAcceptanceStatus": { + "get": { + "description": "Returns multiple [[SoftLayer_Container_Policy_Acceptance]] that represent the acceptance status of the applicable third-party policies for this account. ", + "summary": "Get the acceptance status of the applicable third-party policies.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getThirdPartyPoliciesAcceptanceStatus/" + }, + "operationId": "SoftLayer_Account::getThirdPartyPoliciesAcceptanceStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Policy_Acceptance" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getValidSecurityCertificateEntries": { + "get": { + "description": "Retrieve a list of valid (non-expired) security certificates without the sensitive certificate information. This allows non-privileged users to view and select security certificates when configuring associated services. ", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getValidSecurityCertificateEntries/" + }, + "operationId": "SoftLayer_Account::getValidSecurityCertificateEntries", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate_Entry" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVmWareActiveAccountLicenseKeys": { + "get": { + "description": "This returns a collection of active VMware software account license keys.", + "summary": "Get a collection of active VMware software account license keys.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVmWareActiveAccountLicenseKeys/" + }, + "operationId": "SoftLayer_Account::getVmWareActiveAccountLicenseKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getWindowsUpdateStatus": { + "get": { + "description": "Retrieve a list of an account's hardware's Windows Update status. This list includes which servers have available updates, which servers require rebooting due to updates, which servers have failed retrieving updates, and which servers have failed to communicate with the SoftLayer private Windows Software Update Services server. ", + "summary": "Retrieve a list of an account's hardware's Windows Update status.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getWindowsUpdateStatus/" + }, + "operationId": "SoftLayer_Account::getWindowsUpdateStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/hasAttribute": { + "post": { + "description": "Determine if an account has an [[SoftLayer_Account_Attribute|attribute]] associated with it. hasAttribute() returns false if the attribute does not exist or if it does not have a value. ", + "summary": "Determine if an account has a given attribute.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/hasAttribute/" + }, + "operationId": "SoftLayer_Account::hasAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::hasAttribute::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::hasAttribute::Parameters::Input", + "properties": { + "attributeType": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/hourlyInstanceLimit": { + "get": { + "description": "This method will return the limit (number) of hourly services the account is allowed to have. ", + "summary": "Retrieve the number of hourly services that an account is allowed to have ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/hourlyInstanceLimit/" + }, + "operationId": "SoftLayer_Account::hourlyInstanceLimit", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/hourlyServerLimit": { + "get": { + "description": "This method will return the limit (number) of hourly bare metal servers the account is allowed to have. ", + "summary": "Retrieve the number of hourly bare metal servers that an account is allowed to have ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/hourlyServerLimit/" + }, + "operationId": "SoftLayer_Account::hourlyServerLimit", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/initiatePayerAuthentication": { + "post": { + "description": "Initiates Payer Authentication and provides data that is required for payer authentication enrollment and device data collection. ", + "summary": "Initiate Payer Authentication", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/initiatePayerAuthentication/" + }, + "operationId": "SoftLayer_Account::initiatePayerAuthentication", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::initiatePayerAuthentication::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::initiatePayerAuthentication::Parameters::Input", + "properties": { + "setupInformation": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup_Information" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/isActiveVmwareCustomer": { + "get": { + "description": null, + "summary": "Determines if the account is considered an active VMware customer and as such eligible to order VMware restricted products. This result is cached for up to 60 seconds. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/isActiveVmwareCustomer/" + }, + "operationId": "SoftLayer_Account::isActiveVmwareCustomer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/isEligibleForLocalCurrencyProgram": { + "get": { + "description": "Returns true if this account is eligible for the local currency program, false otherwise. ", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/isEligibleForLocalCurrencyProgram/" + }, + "operationId": "SoftLayer_Account::isEligibleForLocalCurrencyProgram", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/isEligibleToLinkWithPaas": { + "get": { + "description": "Returns true if this account is eligible to link with PaaS. False otherwise. ", + "summary": "Returns true if this account is eligible to link with PaaS. False otherwise. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/isEligibleToLinkWithPaas/" + }, + "operationId": "SoftLayer_Account::isEligibleToLinkWithPaas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/linkExternalAccount": { + "post": { + "description": "This method will link this SoftLayer account with the provided external account. ", + "summary": "This method will link this SoftLayer account with the provided external account. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/linkExternalAccount/" + }, + "operationId": "SoftLayer_Account::linkExternalAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "null" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::linkExternalAccount::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::linkExternalAccount::Parameters::Input", + "properties": { + "externalAccountId": { + "type": "string" + }, + "authorizationToken": { + "type": "string" + }, + "externalServiceProviderKey": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/removeAlternateCreditCard": { + "get": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/removeAlternateCreditCard/" + }, + "operationId": "SoftLayer_Account::removeAlternateCreditCard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/requestCreditCardChange": { + "post": { + "description": "Retrieve the record data associated with the submission of a Credit Card Change Request. Softlayer customers are permitted to request a change in Credit Card information. Part of the process calls for an attempt by SoftLayer to submit at $1.00 charge to the financial institution backing the credit card as a means of verifying that the information provided in the change request is valid. The data associated with this change request returned to the calling function. \n\nIf the onlyChangeNicknameFlag parameter is set to true, the nickname of the credit card will be changed immediately without requiring approval by an agent. To change the nickname of the active payment method, pass the empty string for paymentRoleName. To change the nickname for the alternate credit card, pass ALTERNATE_CREDIT_CARD as the paymentRoleName. vatId must be set, but the value will not be used and the empty string is acceptable. ", + "summary": "Retrieve the record data associated with the submission of a Credit Card Change Request.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/requestCreditCardChange/" + }, + "operationId": "SoftLayer_Account::requestCreditCardChange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_Card_ChangeRequest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::requestCreditCardChange::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::requestCreditCardChange::Parameters::Input", + "properties": { + "request": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_Card_ChangeRequest" + }, + "vatId": { + "type": "string" + }, + "paymentRoleName": { + "type": "string" + }, + "onlyChangeNicknameFlag": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/requestManualPayment": { + "post": { + "description": "Retrieve the record data associated with the submission of a Manual Payment Request. Softlayer customers are permitted to request a manual one-time payment at a minimum amount of $2.00. Customers may submit a Credit Card Payment (Mastercard, Visa, American Express) or a PayPal payment. For Credit Card Payments, SoftLayer engages the credit card financial institution to submit the payment request. The financial institution's response and other data associated with the transaction are returned to the calling function. In the case of PayPal Payments, SoftLayer engages the PayPal system to initiate the PayPal payment sequence. The applicable data generated during the request is returned to the calling function. ", + "summary": "Retrieve the record data associated with the submission of a Manual Payment Request.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/requestManualPayment/" + }, + "operationId": "SoftLayer_Account::requestManualPayment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_Card_ManualPayment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::requestManualPayment::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::requestManualPayment::Parameters::Input", + "properties": { + "request": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_Card_ManualPayment" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/requestManualPaymentUsingCreditCardOnFile": { + "post": { + "description": "Retrieve the record data associated with the submission of a Manual Payment Request for a manual payment using a credit card which is on file and does not require an approval process. Softlayer customers are permitted to request a manual one-time payment at a minimum amount of $2.00. Customers may use an existing Credit Card on file (Mastercard, Visa, American Express). SoftLayer engages the credit card financial institution to submit the payment request. The financial institution's response and other data associated with the transaction are returned to the calling function. The applicable data generated during the request is returned to the calling function. ", + "summary": "Retrieve the record data associated with the submission of a Manual Payment Request which charges the manual payment to a credit card already on file. ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/requestManualPaymentUsingCreditCardOnFile/" + }, + "operationId": "SoftLayer_Account::requestManualPaymentUsingCreditCardOnFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_Card_ManualPayment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::requestManualPaymentUsingCreditCardOnFile::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::requestManualPaymentUsingCreditCardOnFile::Parameters::Input", + "properties": { + "amount": { + "type": "string" + }, + "payWithAlternateCardFlag": { + "type": "boolean" + }, + "note": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/saveInternalCostRecovery": { + "post": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/saveInternalCostRecovery/" + }, + "operationId": "SoftLayer_Account::saveInternalCostRecovery", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "null" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::saveInternalCostRecovery::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::saveInternalCostRecovery::Parameters::Input", + "properties": { + "costRecoveryContainer": { + "$ref": "#/components/schemas/SoftLayer_Container_Account_Internal_Ibm_CostRecovery" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/setAbuseEmails": { + "post": { + "description": "Set this account's abuse emails. Takes an array of email addresses as strings. ", + "summary": "Set this account's abuse emails.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/setAbuseEmails/" + }, + "operationId": "SoftLayer_Account::setAbuseEmails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::setAbuseEmails::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::setAbuseEmails::Parameters::Input", + "properties": { + "emails": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/setManagedPoolQuantity": { + "post": { + "description": "Set the total number of servers that are to be maintained in the given pool. When a server is ordered a new server will be put in the pool to replace the server that was removed to fill an order to maintain the desired pool availability quantity. ", + "summary": "Set the number of desired servers in the pool", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/setManagedPoolQuantity/" + }, + "operationId": "SoftLayer_Account::setManagedPoolQuantity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::setManagedPoolQuantity::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::setManagedPoolQuantity::Parameters::Input", + "properties": { + "poolKeyName": { + "type": "string" + }, + "backendRouter": { + "type": "string" + }, + "quantity": { + "type": "number" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/setVlanSpan": { + "post": { + "description": "Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account. Enabling VLAN spanning allows an account's servers to talk on the same broadcast domain even if they reside within different private vlans. ", + "summary": "Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/setVlanSpan/" + }, + "operationId": "SoftLayer_Account::setVlanSpan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::setVlanSpan::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::setVlanSpan::Parameters::Input", + "properties": { + "enabled": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/swapCreditCards": { + "get": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/swapCreditCards/" + }, + "operationId": "SoftLayer_Account::swapCreditCards", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/syncCurrentUserPopulationWithPaas": { + "get": { + "description": null, + "summary": "This method manually starts a synchronize operation for the current IBMid-authenticated user population of a linked account pair. \"Manually\" means \"independent of an account link operation\". ", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/syncCurrentUserPopulationWithPaas/" + }, + "operationId": "SoftLayer_Account::syncCurrentUserPopulationWithPaas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "null" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/updateVpnUsersForResource": { + "post": { + "description": "[DEPRECATED] This method has been deprecated and will simply return false. ", + "summary": "[DEPRECATED] Creates or updates a user VPN access privileges for a server on account.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/updateVpnUsersForResource/" + }, + "operationId": "SoftLayer_Account::updateVpnUsersForResource", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::updateVpnUsersForResource::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::updateVpnUsersForResource::Parameters::Input", + "properties": { + "objectId": { + "type": "number" + }, + "objectType": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/validate": { + "post": { + "description": "This method will validate the following account fields. Included are the allowed characters for each field.Company Name (required): alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parenthesis, exclamation point. Maximum length: 100 characters. (Note: may not contain an email address)
First Name (required): alphabet, space, period, dash, comma, apostrophe. Maximum length: 30 characters.
Last Name (required): alphabet, space, period, dash, comma, apostrophe. Maximum length: 30 characters.
Email (required): Validates e-mail addresses against the syntax in RFC 822.
Address 1 (required): alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parentheses. Maximum length: 100 characters. (Note: may not contain an email address)
Address 2: alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parentheses. Maximum length: 100 characters. (Note: may not contain an email address)
City (required): alphabet, numbers, space, period, dash, apostrophe, forward slash, comma, parenthesis. Maximum length: 100 characters.
State (required if country is US, Brazil, Canada or India): Must be valid Alpha-2 ISO 3166-1 state code for that country.
Postal Code (required if country is US or Canada): Accepted characters are alphabet, numbers, dash, space. Maximum length: 50 characters.
Country (required): alphabet, numbers. Must be valid Alpha-2 ISO 3166-1 country code.
Office Phone (required): alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 100 characters.
Alternate Phone: alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 100 characters.
Fax Phone: alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 20 characters.
", + "summary": "Validates SoftLayer account information. Will return an error if any field is not valid.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/validate/" + }, + "operationId": "SoftLayer_Account::validate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::validate::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::validate::Parameters::Input", + "properties": { + "account": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/validateManualPaymentAmount": { + "post": { + "description": "This method checks global and account specific requirements and returns true if the dollar amount entered is acceptable for this account and false otherwise. Please note the dollar amount is in USD. ", + "summary": "Ensure the amount requested for a manual payment is valid.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/validateManualPaymentAmount/" + }, + "operationId": "SoftLayer_Account::validateManualPaymentAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account::validateManualPaymentAmount::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account::validateManualPaymentAmount::Parameters::Input", + "properties": { + "amount": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account/getAbuseEmail": { + "get": { + "description": "An email address that is responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to this address.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAbuseEmail/" + }, + "operationId": "SoftLayer_Account::getAbuseEmail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAbuseEmails": { + "get": { + "description": "Email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAbuseEmails/" + }, + "operationId": "SoftLayer_Account::getAbuseEmails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_AbuseEmail" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAccountContacts": { + "get": { + "description": "The account contacts on an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAccountContacts/" + }, + "operationId": "SoftLayer_Account::getAccountContacts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Contact" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAccountLicenses": { + "get": { + "description": "The account software licenses owned by an account", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAccountLicenses/" + }, + "operationId": "SoftLayer_Account::getAccountLicenses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_AccountLicense" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAccountLinks": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAccountLinks/" + }, + "operationId": "SoftLayer_Account::getAccountLinks", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Link" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAccountStatus": { + "get": { + "description": "An account's status presented in a more detailed data type.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAccountStatus/" + }, + "operationId": "SoftLayer_Account::getAccountStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveAccountDiscountBillingItem": { + "get": { + "description": "The billing item associated with an account's monthly discount.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveAccountDiscountBillingItem/" + }, + "operationId": "SoftLayer_Account::getActiveAccountDiscountBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveAccountLicenses": { + "get": { + "description": "The active account software licenses owned by an account", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveAccountLicenses/" + }, + "operationId": "SoftLayer_Account::getActiveAccountLicenses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_AccountLicense" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveAddresses": { + "get": { + "description": "The active address(es) that belong to an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveAddresses/" + }, + "operationId": "SoftLayer_Account::getActiveAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveAgreements": { + "get": { + "description": "All active agreements for an account", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveAgreements/" + }, + "operationId": "SoftLayer_Account::getActiveAgreements", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveBillingAgreements": { + "get": { + "description": "All billing agreements for an account", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveBillingAgreements/" + }, + "operationId": "SoftLayer_Account::getActiveBillingAgreements", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveCatalystEnrollment": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveCatalystEnrollment/" + }, + "operationId": "SoftLayer_Account::getActiveCatalystEnrollment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Catalyst_Enrollment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveColocationContainers": { + "get": { + "description": "Deprecated.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveColocationContainers/" + }, + "operationId": "SoftLayer_Account::getActiveColocationContainers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveFlexibleCreditEnrollment": { + "get": { + "description": "[Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollment/" + }, + "operationId": "SoftLayer_Account::getActiveFlexibleCreditEnrollment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_FlexibleCredit_Enrollment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveFlexibleCreditEnrollments": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollments/" + }, + "operationId": "SoftLayer_Account::getActiveFlexibleCreditEnrollments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_FlexibleCredit_Enrollment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveNotificationSubscribers": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveNotificationSubscribers/" + }, + "operationId": "SoftLayer_Account::getActiveNotificationSubscribers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Subscriber" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveQuotes": { + "get": { + "description": "An account's non-expired quotes.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveQuotes/" + }, + "operationId": "SoftLayer_Account::getActiveQuotes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveReservedCapacityAgreements": { + "get": { + "description": "Active reserved capacity agreements for an account", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveReservedCapacityAgreements/" + }, + "operationId": "SoftLayer_Account::getActiveReservedCapacityAgreements", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getActiveVirtualLicenses": { + "get": { + "description": "The virtual software licenses controlled by an account", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getActiveVirtualLicenses/" + }, + "operationId": "SoftLayer_Account::getActiveVirtualLicenses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_VirtualLicense" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAdcLoadBalancers": { + "get": { + "description": "An account's associated load balancers.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAdcLoadBalancers/" + }, + "operationId": "SoftLayer_Account::getAdcLoadBalancers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAddresses": { + "get": { + "description": "All the address(es) that belong to an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAddresses/" + }, + "operationId": "SoftLayer_Account::getAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAffiliateId": { + "get": { + "description": "An affiliate identifier associated with the customer account. ", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAffiliateId/" + }, + "operationId": "SoftLayer_Account::getAffiliateId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAllBillingItems": { + "get": { + "description": "The billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAllBillingItems/" + }, + "operationId": "SoftLayer_Account::getAllBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAllCommissionBillingItems": { + "get": { + "description": "The billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAllCommissionBillingItems/" + }, + "operationId": "SoftLayer_Account::getAllCommissionBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAllRecurringTopLevelBillingItems": { + "get": { + "description": "The billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItems/" + }, + "operationId": "SoftLayer_Account::getAllRecurringTopLevelBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAllRecurringTopLevelBillingItemsUnfiltered": { + "get": { + "description": "The billing items that will be on an account's next invoice. Does not consider associated items.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItemsUnfiltered/" + }, + "operationId": "SoftLayer_Account::getAllRecurringTopLevelBillingItemsUnfiltered", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAllSubnetBillingItems": { + "get": { + "description": "The billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAllSubnetBillingItems/" + }, + "operationId": "SoftLayer_Account::getAllSubnetBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAllTopLevelBillingItems": { + "get": { + "description": "All billing items of an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAllTopLevelBillingItems/" + }, + "operationId": "SoftLayer_Account::getAllTopLevelBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAllTopLevelBillingItemsUnfiltered": { + "get": { + "description": "The billing items that will be on an account's next invoice. Does not consider associated items.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAllTopLevelBillingItemsUnfiltered/" + }, + "operationId": "SoftLayer_Account::getAllTopLevelBillingItemsUnfiltered", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAllowIbmIdSilentMigrationFlag": { + "get": { + "description": "Indicates whether this account is allowed to silently migrate to use IBMid Authentication.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAllowIbmIdSilentMigrationFlag/" + }, + "operationId": "SoftLayer_Account::getAllowIbmIdSilentMigrationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAllowsBluemixAccountLinkingFlag": { + "get": { + "description": "Flag indicating if this account can be linked with Bluemix.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAllowsBluemixAccountLinkingFlag/" + }, + "operationId": "SoftLayer_Account::getAllowsBluemixAccountLinkingFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getApplicationDeliveryControllers": { + "get": { + "description": "An account's associated application delivery controller records.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getApplicationDeliveryControllers/" + }, + "operationId": "SoftLayer_Account::getApplicationDeliveryControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAttributes": { + "get": { + "description": "The account attribute values for a SoftLayer customer account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAttributes/" + }, + "operationId": "SoftLayer_Account::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getAvailablePublicNetworkVlans": { + "get": { + "description": "The public network VLANs assigned to an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAvailablePublicNetworkVlans/" + }, + "operationId": "SoftLayer_Account::getAvailablePublicNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBalance": { + "get": { + "description": "The account balance of a SoftLayer customer account. An account's balance is the amount of money owed to SoftLayer by the account holder, returned as a floating point number with two decimal places, measured in US Dollars ($USD). A negative account balance means the account holder has overpaid and is owed money by SoftLayer.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBalance/" + }, + "operationId": "SoftLayer_Account::getBalance", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBandwidthAllotments": { + "get": { + "description": "The bandwidth allotments for an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBandwidthAllotments/" + }, + "operationId": "SoftLayer_Account::getBandwidthAllotments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBandwidthAllotmentsOverAllocation": { + "get": { + "description": "The bandwidth allotments for an account currently over allocation.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBandwidthAllotmentsOverAllocation/" + }, + "operationId": "SoftLayer_Account::getBandwidthAllotmentsOverAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBandwidthAllotmentsProjectedOverAllocation": { + "get": { + "description": "The bandwidth allotments for an account projected to go over allocation.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBandwidthAllotmentsProjectedOverAllocation/" + }, + "operationId": "SoftLayer_Account::getBandwidthAllotmentsProjectedOverAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBareMetalInstances": { + "get": { + "description": "An account's associated bare metal server objects.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBareMetalInstances/" + }, + "operationId": "SoftLayer_Account::getBareMetalInstances", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBillingAgreements": { + "get": { + "description": "All billing agreements for an account", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBillingAgreements/" + }, + "operationId": "SoftLayer_Account::getBillingAgreements", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBillingInfo": { + "get": { + "description": "An account's billing information.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBillingInfo/" + }, + "operationId": "SoftLayer_Account::getBillingInfo", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Info" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBlockDeviceTemplateGroups": { + "get": { + "description": "Private template group objects (parent and children) and the shared template group objects (parent only) for an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBlockDeviceTemplateGroups/" + }, + "operationId": "SoftLayer_Account::getBlockDeviceTemplateGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBlockSelfServiceBrandMigration": { + "get": { + "description": "Flag indicating whether this account is restricted from performing a self-service brand migration by updating their credit card details.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBlockSelfServiceBrandMigration/" + }, + "operationId": "SoftLayer_Account::getBlockSelfServiceBrandMigration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBluemixAccountId": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBluemixAccountId/" + }, + "operationId": "SoftLayer_Account::getBluemixAccountId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBluemixAccountLink": { + "get": { + "description": "The Platform account link associated with this SoftLayer account, if one exists.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBluemixAccountLink/" + }, + "operationId": "SoftLayer_Account::getBluemixAccountLink", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Link_Bluemix" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBluemixLinkedFlag": { + "get": { + "description": "Returns true if this account is linked to IBM Bluemix, false if not.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBluemixLinkedFlag/" + }, + "operationId": "SoftLayer_Account::getBluemixLinkedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBrand": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBrand/" + }, + "operationId": "SoftLayer_Account::getBrand", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBrandAccountFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBrandAccountFlag/" + }, + "operationId": "SoftLayer_Account::getBrandAccountFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBrandKeyName": { + "get": { + "description": "The brand keyName.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBrandKeyName/" + }, + "operationId": "SoftLayer_Account::getBrandKeyName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getBusinessPartner": { + "get": { + "description": "The Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBusinessPartner/" + }, + "operationId": "SoftLayer_Account::getBusinessPartner", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Business_Partner" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getCanOrderAdditionalVlansFlag": { + "get": { + "description": "[DEPRECATED] All accounts may order VLANs.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getCanOrderAdditionalVlansFlag/" + }, + "operationId": "SoftLayer_Account::getCanOrderAdditionalVlansFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getCarts": { + "get": { + "description": "An account's active carts.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getCarts/" + }, + "operationId": "SoftLayer_Account::getCarts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getCatalystEnrollments": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getCatalystEnrollments/" + }, + "operationId": "SoftLayer_Account::getCatalystEnrollments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Catalyst_Enrollment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getClosedTickets": { + "get": { + "description": "All closed tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getClosedTickets/" + }, + "operationId": "SoftLayer_Account::getClosedTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getDatacentersWithSubnetAllocations": { + "get": { + "description": "Datacenters which contain subnets that the account has access to route.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getDatacentersWithSubnetAllocations/" + }, + "operationId": "SoftLayer_Account::getDatacentersWithSubnetAllocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getDedicatedHosts": { + "get": { + "description": "An account's associated virtual dedicated host objects.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getDedicatedHosts/" + }, + "operationId": "SoftLayer_Account::getDedicatedHosts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_DedicatedHost" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getDisablePaymentProcessingFlag": { + "get": { + "description": "A flag indicating whether payments are processed for this account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getDisablePaymentProcessingFlag/" + }, + "operationId": "SoftLayer_Account::getDisablePaymentProcessingFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getDisplaySupportRepresentativeAssignments": { + "get": { + "description": "The SoftLayer employees that an account is assigned to.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getDisplaySupportRepresentativeAssignments/" + }, + "operationId": "SoftLayer_Account::getDisplaySupportRepresentativeAssignments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Attachment_Employee" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getDomains": { + "get": { + "description": "The DNS domains associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getDomains/" + }, + "operationId": "SoftLayer_Account::getDomains", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Dns_Domain" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getDomainsWithoutSecondaryDnsRecords": { + "get": { + "description": "The DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getDomainsWithoutSecondaryDnsRecords/" + }, + "operationId": "SoftLayer_Account::getDomainsWithoutSecondaryDnsRecords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Dns_Domain" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getEuSupportedFlag": { + "get": { + "description": "Boolean flag dictating whether or not this account has the EU Supported flag. This flag indicates that this account uses IBM Cloud services to process EU citizen's personal data.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getEuSupportedFlag/" + }, + "operationId": "SoftLayer_Account::getEuSupportedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getEvaultCapacityGB": { + "get": { + "description": "The total capacity of Legacy EVault Volumes on an account, in GB.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getEvaultCapacityGB/" + }, + "operationId": "SoftLayer_Account::getEvaultCapacityGB", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getEvaultMasterUsers": { + "get": { + "description": "An account's master EVault user. This is only used when an account has EVault service.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getEvaultMasterUsers/" + }, + "operationId": "SoftLayer_Account::getEvaultMasterUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Password" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getEvaultNetworkStorage": { + "get": { + "description": "An account's associated EVault storage volumes.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getEvaultNetworkStorage/" + }, + "operationId": "SoftLayer_Account::getEvaultNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getExpiredSecurityCertificates": { + "get": { + "description": "Stored security certificates that are expired (ie. SSL)", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getExpiredSecurityCertificates/" + }, + "operationId": "SoftLayer_Account::getExpiredSecurityCertificates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getFacilityLogs": { + "get": { + "description": "Logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getFacilityLogs/" + }, + "operationId": "SoftLayer_Account::getFacilityLogs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Access_Facility_Log" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getFileBlockBetaAccessFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getFileBlockBetaAccessFlag/" + }, + "operationId": "SoftLayer_Account::getFileBlockBetaAccessFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getFlexibleCreditEnrollments": { + "get": { + "description": "All of the account's current and former Flexible Credit enrollments.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getFlexibleCreditEnrollments/" + }, + "operationId": "SoftLayer_Account::getFlexibleCreditEnrollments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_FlexibleCredit_Enrollment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getForcePaasAccountLinkDate": { + "get": { + "description": "Timestamp representing the point in time when an account is required to link with PaaS.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getForcePaasAccountLinkDate/" + }, + "operationId": "SoftLayer_Account::getForcePaasAccountLinkDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getGlobalIpRecords": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getGlobalIpRecords/" + }, + "operationId": "SoftLayer_Account::getGlobalIpRecords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress_Global" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getGlobalIpv4Records": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getGlobalIpv4Records/" + }, + "operationId": "SoftLayer_Account::getGlobalIpv4Records", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress_Global" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getGlobalIpv6Records": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getGlobalIpv6Records/" + }, + "operationId": "SoftLayer_Account::getGlobalIpv6Records", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress_Global" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardware": { + "get": { + "description": "An account's associated hardware objects.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardware/" + }, + "operationId": "SoftLayer_Account::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareOverBandwidthAllocation": { + "get": { + "description": "An account's associated hardware objects currently over bandwidth allocation.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareOverBandwidthAllocation/" + }, + "operationId": "SoftLayer_Account::getHardwareOverBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareProjectedOverBandwidthAllocation": { + "get": { + "description": "An account's associated hardware objects projected to go over bandwidth allocation.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareProjectedOverBandwidthAllocation/" + }, + "operationId": "SoftLayer_Account::getHardwareProjectedOverBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareWithCpanel": { + "get": { + "description": "All hardware associated with an account that has the cPanel web hosting control panel installed.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareWithCpanel/" + }, + "operationId": "SoftLayer_Account::getHardwareWithCpanel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareWithHelm": { + "get": { + "description": "All hardware associated with an account that has the Helm web hosting control panel installed.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareWithHelm/" + }, + "operationId": "SoftLayer_Account::getHardwareWithHelm", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareWithMcafee": { + "get": { + "description": "All hardware associated with an account that has McAfee Secure software components.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareWithMcafee/" + }, + "operationId": "SoftLayer_Account::getHardwareWithMcafee", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareWithMcafeeAntivirusRedhat": { + "get": { + "description": "All hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusRedhat/" + }, + "operationId": "SoftLayer_Account::getHardwareWithMcafeeAntivirusRedhat", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareWithMcafeeAntivirusWindows": { + "get": { + "description": "All hardware associated with an account that has McAfee Secure AntiVirus for Windows software components.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusWindows/" + }, + "operationId": "SoftLayer_Account::getHardwareWithMcafeeAntivirusWindows", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareWithMcafeeIntrusionDetectionSystem": { + "get": { + "description": "All hardware associated with an account that has McAfee Secure Intrusion Detection System software components.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareWithMcafeeIntrusionDetectionSystem/" + }, + "operationId": "SoftLayer_Account::getHardwareWithMcafeeIntrusionDetectionSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareWithPlesk": { + "get": { + "description": "All hardware associated with an account that has the Plesk web hosting control panel installed.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareWithPlesk/" + }, + "operationId": "SoftLayer_Account::getHardwareWithPlesk", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareWithQuantastor": { + "get": { + "description": "All hardware associated with an account that has the QuantaStor storage system installed.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareWithQuantastor/" + }, + "operationId": "SoftLayer_Account::getHardwareWithQuantastor", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareWithUrchin": { + "get": { + "description": "All hardware associated with an account that has the Urchin web traffic analytics package installed.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareWithUrchin/" + }, + "operationId": "SoftLayer_Account::getHardwareWithUrchin", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHardwareWithWindows": { + "get": { + "description": "All hardware associated with an account that is running a version of the Microsoft Windows operating system.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHardwareWithWindows/" + }, + "operationId": "SoftLayer_Account::getHardwareWithWindows", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHasEvaultBareMetalRestorePluginFlag": { + "get": { + "description": "Return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHasEvaultBareMetalRestorePluginFlag/" + }, + "operationId": "SoftLayer_Account::getHasEvaultBareMetalRestorePluginFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHasIderaBareMetalRestorePluginFlag": { + "get": { + "description": "Return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHasIderaBareMetalRestorePluginFlag/" + }, + "operationId": "SoftLayer_Account::getHasIderaBareMetalRestorePluginFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHasPendingOrder": { + "get": { + "description": "The number of orders in a PENDING status for a SoftLayer customer account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHasPendingOrder/" + }, + "operationId": "SoftLayer_Account::getHasPendingOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHasR1softBareMetalRestorePluginFlag": { + "get": { + "description": "Return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHasR1softBareMetalRestorePluginFlag/" + }, + "operationId": "SoftLayer_Account::getHasR1softBareMetalRestorePluginFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHourlyBareMetalInstances": { + "get": { + "description": "An account's associated hourly bare metal server objects.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHourlyBareMetalInstances/" + }, + "operationId": "SoftLayer_Account::getHourlyBareMetalInstances", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHourlyServiceBillingItems": { + "get": { + "description": "Hourly service billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHourlyServiceBillingItems/" + }, + "operationId": "SoftLayer_Account::getHourlyServiceBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHourlyVirtualGuests": { + "get": { + "description": "An account's associated hourly virtual guest objects.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHourlyVirtualGuests/" + }, + "operationId": "SoftLayer_Account::getHourlyVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getHubNetworkStorage": { + "get": { + "description": "An account's associated Virtual Storage volumes.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHubNetworkStorage/" + }, + "operationId": "SoftLayer_Account::getHubNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getIbmCustomerNumber": { + "get": { + "description": "Unique identifier for a customer used throughout IBM.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getIbmCustomerNumber/" + }, + "operationId": "SoftLayer_Account::getIbmCustomerNumber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getIbmIdAuthenticationRequiredFlag": { + "get": { + "description": "Indicates whether this account requires IBMid authentication.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getIbmIdAuthenticationRequiredFlag/" + }, + "operationId": "SoftLayer_Account::getIbmIdAuthenticationRequiredFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getIbmIdMigrationExpirationTimestamp": { + "get": { + "description": "This key is deprecated and should not be used.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getIbmIdMigrationExpirationTimestamp/" + }, + "operationId": "SoftLayer_Account::getIbmIdMigrationExpirationTimestamp", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getInProgressExternalAccountSetup": { + "get": { + "description": "An in progress request to switch billing systems.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getInProgressExternalAccountSetup/" + }, + "operationId": "SoftLayer_Account::getInProgressExternalAccountSetup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_External_Setup" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getInternalCciHostAccountFlag": { + "get": { + "description": "Account attribute flag indicating internal cci host account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getInternalCciHostAccountFlag/" + }, + "operationId": "SoftLayer_Account::getInternalCciHostAccountFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getInternalImageTemplateCreationFlag": { + "get": { + "description": "Account attribute flag indicating account creates internal image templates.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getInternalImageTemplateCreationFlag/" + }, + "operationId": "SoftLayer_Account::getInternalImageTemplateCreationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getInternalNotes": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getInternalNotes/" + }, + "operationId": "SoftLayer_Account::getInternalNotes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Note" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getInternalRestrictionFlag": { + "get": { + "description": "Account attribute flag indicating restricted account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getInternalRestrictionFlag/" + }, + "operationId": "SoftLayer_Account::getInternalRestrictionFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getInvoices": { + "get": { + "description": "An account's associated billing invoices.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getInvoices/" + }, + "operationId": "SoftLayer_Account::getInvoices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getIpAddresses": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getIpAddresses/" + }, + "operationId": "SoftLayer_Account::getIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getIscsiIsolationDisabled": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getIscsiIsolationDisabled/" + }, + "operationId": "SoftLayer_Account::getIscsiIsolationDisabled", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getIscsiNetworkStorage": { + "get": { + "description": "An account's associated iSCSI storage volumes.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getIscsiNetworkStorage/" + }, + "operationId": "SoftLayer_Account::getIscsiNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLastCanceledBillingItem": { + "get": { + "description": "The most recently canceled billing item.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLastCanceledBillingItem/" + }, + "operationId": "SoftLayer_Account::getLastCanceledBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLastCancelledServerBillingItem": { + "get": { + "description": "The most recent cancelled server billing item.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLastCancelledServerBillingItem/" + }, + "operationId": "SoftLayer_Account::getLastCancelledServerBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLastFiveClosedAbuseTickets": { + "get": { + "description": "The five most recently closed abuse tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLastFiveClosedAbuseTickets/" + }, + "operationId": "SoftLayer_Account::getLastFiveClosedAbuseTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLastFiveClosedAccountingTickets": { + "get": { + "description": "The five most recently closed accounting tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLastFiveClosedAccountingTickets/" + }, + "operationId": "SoftLayer_Account::getLastFiveClosedAccountingTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLastFiveClosedOtherTickets": { + "get": { + "description": "The five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLastFiveClosedOtherTickets/" + }, + "operationId": "SoftLayer_Account::getLastFiveClosedOtherTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLastFiveClosedSalesTickets": { + "get": { + "description": "The five most recently closed sales tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLastFiveClosedSalesTickets/" + }, + "operationId": "SoftLayer_Account::getLastFiveClosedSalesTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLastFiveClosedSupportTickets": { + "get": { + "description": "The five most recently closed support tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLastFiveClosedSupportTickets/" + }, + "operationId": "SoftLayer_Account::getLastFiveClosedSupportTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLastFiveClosedTickets": { + "get": { + "description": "The five most recently closed tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLastFiveClosedTickets/" + }, + "operationId": "SoftLayer_Account::getLastFiveClosedTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLatestBillDate": { + "get": { + "description": "An account's most recent billing date.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLatestBillDate/" + }, + "operationId": "SoftLayer_Account::getLatestBillDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLatestRecurringInvoice": { + "get": { + "description": "An account's latest recurring invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLatestRecurringInvoice/" + }, + "operationId": "SoftLayer_Account::getLatestRecurringInvoice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLatestRecurringPendingInvoice": { + "get": { + "description": "An account's latest recurring pending invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLatestRecurringPendingInvoice/" + }, + "operationId": "SoftLayer_Account::getLatestRecurringPendingInvoice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLegacyIscsiCapacityGB": { + "get": { + "description": "The total capacity of Legacy iSCSI Volumes on an account, in GB.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLegacyIscsiCapacityGB/" + }, + "operationId": "SoftLayer_Account::getLegacyIscsiCapacityGB", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLoadBalancers": { + "get": { + "description": "An account's associated load balancers.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLoadBalancers/" + }, + "operationId": "SoftLayer_Account::getLoadBalancers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_VirtualIpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLockboxCapacityGB": { + "get": { + "description": "The total capacity of Legacy lockbox Volumes on an account, in GB.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLockboxCapacityGB/" + }, + "operationId": "SoftLayer_Account::getLockboxCapacityGB", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getLockboxNetworkStorage": { + "get": { + "description": "An account's associated Lockbox storage volumes.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLockboxNetworkStorage/" + }, + "operationId": "SoftLayer_Account::getLockboxNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getManualPaymentsUnderReview": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getManualPaymentsUnderReview/" + }, + "operationId": "SoftLayer_Account::getManualPaymentsUnderReview", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_Card_ManualPayment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getMasterUser": { + "get": { + "description": "An account's master user.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getMasterUser/" + }, + "operationId": "SoftLayer_Account::getMasterUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getMediaDataTransferRequests": { + "get": { + "description": "An account's media transfer service requests.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getMediaDataTransferRequests/" + }, + "operationId": "SoftLayer_Account::getMediaDataTransferRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Media_Data_Transfer_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getMigratedToIbmCloudPortalFlag": { + "get": { + "description": "Flag indicating whether this account is restricted to the IBM Cloud portal.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getMigratedToIbmCloudPortalFlag/" + }, + "operationId": "SoftLayer_Account::getMigratedToIbmCloudPortalFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getMonthlyBareMetalInstances": { + "get": { + "description": "An account's associated monthly bare metal server objects.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getMonthlyBareMetalInstances/" + }, + "operationId": "SoftLayer_Account::getMonthlyBareMetalInstances", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getMonthlyVirtualGuests": { + "get": { + "description": "An account's associated monthly virtual guest objects.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getMonthlyVirtualGuests/" + }, + "operationId": "SoftLayer_Account::getMonthlyVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNasNetworkStorage": { + "get": { + "description": "An account's associated NAS storage volumes.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNasNetworkStorage/" + }, + "operationId": "SoftLayer_Account::getNasNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkCreationFlag": { + "get": { + "description": "[Deprecated] Whether or not this account can define their own networks.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkCreationFlag/" + }, + "operationId": "SoftLayer_Account::getNetworkCreationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkGateways": { + "get": { + "description": "All network gateway devices on this account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkGateways/" + }, + "operationId": "SoftLayer_Account::getNetworkGateways", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkHardware": { + "get": { + "description": "An account's associated network hardware.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkHardware/" + }, + "operationId": "SoftLayer_Account::getNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkMessageDeliveryAccounts": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkMessageDeliveryAccounts/" + }, + "operationId": "SoftLayer_Account::getNetworkMessageDeliveryAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Message_Delivery" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkMonitorDownHardware": { + "get": { + "description": "Hardware which is currently experiencing a service failure.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkMonitorDownHardware/" + }, + "operationId": "SoftLayer_Account::getNetworkMonitorDownHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkMonitorDownVirtualGuests": { + "get": { + "description": "Virtual guest which is currently experiencing a service failure.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkMonitorDownVirtualGuests/" + }, + "operationId": "SoftLayer_Account::getNetworkMonitorDownVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkMonitorRecoveringHardware": { + "get": { + "description": "Hardware which is currently recovering from a service failure.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringHardware/" + }, + "operationId": "SoftLayer_Account::getNetworkMonitorRecoveringHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkMonitorRecoveringVirtualGuests": { + "get": { + "description": "Virtual guest which is currently recovering from a service failure.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringVirtualGuests/" + }, + "operationId": "SoftLayer_Account::getNetworkMonitorRecoveringVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkMonitorUpHardware": { + "get": { + "description": "Hardware which is currently online.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkMonitorUpHardware/" + }, + "operationId": "SoftLayer_Account::getNetworkMonitorUpHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkMonitorUpVirtualGuests": { + "get": { + "description": "Virtual guest which is currently online.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkMonitorUpVirtualGuests/" + }, + "operationId": "SoftLayer_Account::getNetworkMonitorUpVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkStorage": { + "get": { + "description": "An account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkStorage/" + }, + "operationId": "SoftLayer_Account::getNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkStorageGroups": { + "get": { + "description": "An account's Network Storage groups.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkStorageGroups/" + }, + "operationId": "SoftLayer_Account::getNetworkStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkTunnelContexts": { + "get": { + "description": "IPSec network tunnels for an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkTunnelContexts/" + }, + "operationId": "SoftLayer_Account::getNetworkTunnelContexts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Tunnel_Module_Context" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkVlanSpan": { + "get": { + "description": "Whether or not an account has automatic private VLAN spanning enabled.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkVlanSpan/" + }, + "operationId": "SoftLayer_Account::getNetworkVlanSpan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Network_Vlan_Span" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNetworkVlans": { + "get": { + "description": "All network VLANs assigned to an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNetworkVlans/" + }, + "operationId": "SoftLayer_Account::getNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceIncubatorExemptTotal": { + "get": { + "description": "The pre-tax total amount exempt from incubator credit for the account's next invoice. This field is now deprecated and will soon be removed. Please update all references to instead use nextInvoiceTotalAmount", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceIncubatorExemptTotal/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceIncubatorExemptTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoicePlatformServicesTotalAmount": { + "get": { + "description": "The pre-tax platform services total amount of an account's next invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoicePlatformServicesTotalAmount/" + }, + "operationId": "SoftLayer_Account::getNextInvoicePlatformServicesTotalAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceRecurringAmountEligibleForAccountDiscount": { + "get": { + "description": "The total recurring charge amount of an account's next invoice eligible for account discount measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceRecurringAmountEligibleForAccountDiscount/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceRecurringAmountEligibleForAccountDiscount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceTopLevelBillingItems": { + "get": { + "description": "The billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTopLevelBillingItems/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceTopLevelBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceTotalAmount": { + "get": { + "description": "The pre-tax total amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalAmount/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceTotalAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceTotalOneTimeAmount": { + "get": { + "description": "The total one-time charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeAmount/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceTotalOneTimeAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceTotalOneTimeTaxAmount": { + "get": { + "description": "The total one-time tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeTaxAmount/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceTotalOneTimeTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceTotalRecurringAmount": { + "get": { + "description": "The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmount/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceTotalRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceTotalRecurringAmountBeforeAccountDiscount": { + "get": { + "description": "The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmountBeforeAccountDiscount/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceTotalRecurringAmountBeforeAccountDiscount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceTotalRecurringTaxAmount": { + "get": { + "description": "The total recurring tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringTaxAmount/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceTotalRecurringTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNextInvoiceTotalTaxableRecurringAmount": { + "get": { + "description": "The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalTaxableRecurringAmount/" + }, + "operationId": "SoftLayer_Account::getNextInvoiceTotalTaxableRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getNotificationSubscribers": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNotificationSubscribers/" + }, + "operationId": "SoftLayer_Account::getNotificationSubscribers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Subscriber" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenAbuseTickets": { + "get": { + "description": "The open abuse tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenAbuseTickets/" + }, + "operationId": "SoftLayer_Account::getOpenAbuseTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenAccountingTickets": { + "get": { + "description": "The open accounting tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenAccountingTickets/" + }, + "operationId": "SoftLayer_Account::getOpenAccountingTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenBillingTickets": { + "get": { + "description": "The open billing tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenBillingTickets/" + }, + "operationId": "SoftLayer_Account::getOpenBillingTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenCancellationRequests": { + "get": { + "description": "An open ticket requesting cancellation of this server, if one exists.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenCancellationRequests/" + }, + "operationId": "SoftLayer_Account::getOpenCancellationRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenOtherTickets": { + "get": { + "description": "The open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenOtherTickets/" + }, + "operationId": "SoftLayer_Account::getOpenOtherTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenRecurringInvoices": { + "get": { + "description": "An account's recurring invoices.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenRecurringInvoices/" + }, + "operationId": "SoftLayer_Account::getOpenRecurringInvoices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenSalesTickets": { + "get": { + "description": "The open sales tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenSalesTickets/" + }, + "operationId": "SoftLayer_Account::getOpenSalesTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenStackAccountLinks": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenStackAccountLinks/" + }, + "operationId": "SoftLayer_Account::getOpenStackAccountLinks", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Link" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenStackObjectStorage": { + "get": { + "description": "An account's associated Openstack related Object Storage accounts.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenStackObjectStorage/" + }, + "operationId": "SoftLayer_Account::getOpenStackObjectStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenSupportTickets": { + "get": { + "description": "The open support tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenSupportTickets/" + }, + "operationId": "SoftLayer_Account::getOpenSupportTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenTickets": { + "get": { + "description": "All open tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenTickets/" + }, + "operationId": "SoftLayer_Account::getOpenTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOpenTicketsWaitingOnCustomer": { + "get": { + "description": "All open tickets associated with an account last edited by an employee.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOpenTicketsWaitingOnCustomer/" + }, + "operationId": "SoftLayer_Account::getOpenTicketsWaitingOnCustomer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOrders": { + "get": { + "description": "An account's associated billing orders excluding upgrades.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOrders/" + }, + "operationId": "SoftLayer_Account::getOrders", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOrphanBillingItems": { + "get": { + "description": "The billing items that have no parent billing item. These are items that don't necessarily belong to a single server.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOrphanBillingItems/" + }, + "operationId": "SoftLayer_Account::getOrphanBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOwnedBrands": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOwnedBrands/" + }, + "operationId": "SoftLayer_Account::getOwnedBrands", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getOwnedHardwareGenericComponentModels": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getOwnedHardwareGenericComponentModels/" + }, + "operationId": "SoftLayer_Account::getOwnedHardwareGenericComponentModels", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model_Generic" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPaymentProcessors": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPaymentProcessors/" + }, + "operationId": "SoftLayer_Account::getPaymentProcessors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_Processor" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPendingEvents": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingEvents/" + }, + "operationId": "SoftLayer_Account::getPendingEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPendingInvoice": { + "get": { + "description": "An account's latest open (pending) invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoice/" + }, + "operationId": "SoftLayer_Account::getPendingInvoice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPendingInvoiceTopLevelItems": { + "get": { + "description": "A list of top-level invoice items that are on an account's currently pending invoice.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTopLevelItems/" + }, + "operationId": "SoftLayer_Account::getPendingInvoiceTopLevelItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPendingInvoiceTotalAmount": { + "get": { + "description": "The total amount of an account's pending invoice, if one exists.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTotalAmount/" + }, + "operationId": "SoftLayer_Account::getPendingInvoiceTotalAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPendingInvoiceTotalOneTimeAmount": { + "get": { + "description": "The total one-time charges for an account's pending invoice, if one exists. In other words, it is the sum of one-time charges, setup fees, and labor fees. It does not include taxes.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeAmount/" + }, + "operationId": "SoftLayer_Account::getPendingInvoiceTotalOneTimeAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPendingInvoiceTotalOneTimeTaxAmount": { + "get": { + "description": "The sum of all the taxes related to one time charges for an account's pending invoice, if one exists.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeTaxAmount/" + }, + "operationId": "SoftLayer_Account::getPendingInvoiceTotalOneTimeTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPendingInvoiceTotalRecurringAmount": { + "get": { + "description": "The total recurring amount of an account's pending invoice, if one exists.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringAmount/" + }, + "operationId": "SoftLayer_Account::getPendingInvoiceTotalRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPendingInvoiceTotalRecurringTaxAmount": { + "get": { + "description": "The total amount of the recurring taxes on an account's pending invoice, if one exists.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringTaxAmount/" + }, + "operationId": "SoftLayer_Account::getPendingInvoiceTotalRecurringTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPermissionGroups": { + "get": { + "description": "An account's permission groups.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPermissionGroups/" + }, + "operationId": "SoftLayer_Account::getPermissionGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPermissionRoles": { + "get": { + "description": "An account's user roles.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPermissionRoles/" + }, + "operationId": "SoftLayer_Account::getPermissionRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Role" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPlacementGroups": { + "get": { + "description": "An account's associated virtual placement groups.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPlacementGroups/" + }, + "operationId": "SoftLayer_Account::getPlacementGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_PlacementGroup" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPortableStorageVolumes": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPortableStorageVolumes/" + }, + "operationId": "SoftLayer_Account::getPortableStorageVolumes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPostProvisioningHooks": { + "get": { + "description": "Customer specified URIs that are downloaded onto a newly provisioned or reloaded server. If the URI is sent over https it will be executed directly on the server.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPostProvisioningHooks/" + }, + "operationId": "SoftLayer_Account::getPostProvisioningHooks", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Hook" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPptpVpnAllowedFlag": { + "get": { + "description": "(Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPptpVpnAllowedFlag/" + }, + "operationId": "SoftLayer_Account::getPptpVpnAllowedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPptpVpnUsers": { + "get": { + "description": "An account's associated portal users with PPTP VPN access. (Deprecated)", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPptpVpnUsers/" + }, + "operationId": "SoftLayer_Account::getPptpVpnUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPreOpenRecurringInvoices": { + "get": { + "description": "An account's invoices in the PRE_OPEN status.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPreOpenRecurringInvoices/" + }, + "operationId": "SoftLayer_Account::getPreOpenRecurringInvoices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPreviousRecurringRevenue": { + "get": { + "description": "The total recurring amount for an accounts previous revenue.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPreviousRecurringRevenue/" + }, + "operationId": "SoftLayer_Account::getPreviousRecurringRevenue", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "number" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPriceRestrictions": { + "get": { + "description": "The item price that an account is restricted to.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPriceRestrictions/" + }, + "operationId": "SoftLayer_Account::getPriceRestrictions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price_Account_Restriction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPriorityOneTickets": { + "get": { + "description": "All priority one tickets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPriorityOneTickets/" + }, + "operationId": "SoftLayer_Account::getPriorityOneTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPrivateBlockDeviceTemplateGroups": { + "get": { + "description": "Private and shared template group objects (parent only) for an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPrivateBlockDeviceTemplateGroups/" + }, + "operationId": "SoftLayer_Account::getPrivateBlockDeviceTemplateGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPrivateIpAddresses": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPrivateIpAddresses/" + }, + "operationId": "SoftLayer_Account::getPrivateIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPrivateNetworkVlans": { + "get": { + "description": "The private network VLANs assigned to an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPrivateNetworkVlans/" + }, + "operationId": "SoftLayer_Account::getPrivateNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPrivateSubnets": { + "get": { + "description": "All private subnets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPrivateSubnets/" + }, + "operationId": "SoftLayer_Account::getPrivateSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getProofOfConceptAccountFlag": { + "get": { + "description": "Boolean flag indicating whether or not this account is a Proof of Concept account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getProofOfConceptAccountFlag/" + }, + "operationId": "SoftLayer_Account::getProofOfConceptAccountFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPublicIpAddresses": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPublicIpAddresses/" + }, + "operationId": "SoftLayer_Account::getPublicIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPublicNetworkVlans": { + "get": { + "description": "The public network VLANs assigned to an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPublicNetworkVlans/" + }, + "operationId": "SoftLayer_Account::getPublicNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getPublicSubnets": { + "get": { + "description": "All public network subnets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPublicSubnets/" + }, + "operationId": "SoftLayer_Account::getPublicSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getQuotes": { + "get": { + "description": "An account's quotes.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getQuotes/" + }, + "operationId": "SoftLayer_Account::getQuotes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getRecentEvents": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getRecentEvents/" + }, + "operationId": "SoftLayer_Account::getRecentEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getReferralPartner": { + "get": { + "description": "The Referral Partner for this account, if any.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getReferralPartner/" + }, + "operationId": "SoftLayer_Account::getReferralPartner", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getReferredAccountFlag": { + "get": { + "description": "Flag indicating if the account was referred.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getReferredAccountFlag/" + }, + "operationId": "SoftLayer_Account::getReferredAccountFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getReferredAccounts": { + "get": { + "description": "If this is a account is a referral partner, the accounts this referral partner has referred", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getReferredAccounts/" + }, + "operationId": "SoftLayer_Account::getReferredAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getRegulatedWorkloads": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getRegulatedWorkloads/" + }, + "operationId": "SoftLayer_Account::getRegulatedWorkloads", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Legal_RegulatedWorkload" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getRemoteManagementCommandRequests": { + "get": { + "description": "Remote management command requests for an account", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getRemoteManagementCommandRequests/" + }, + "operationId": "SoftLayer_Account::getRemoteManagementCommandRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_Command_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getReplicationEvents": { + "get": { + "description": "The Replication events for all Network Storage volumes on an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getReplicationEvents/" + }, + "operationId": "SoftLayer_Account::getReplicationEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getRequireSilentIBMidUserCreation": { + "get": { + "description": "Indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getRequireSilentIBMidUserCreation/" + }, + "operationId": "SoftLayer_Account::getRequireSilentIBMidUserCreation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getReservedCapacityAgreements": { + "get": { + "description": "All reserved capacity agreements for an account", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getReservedCapacityAgreements/" + }, + "operationId": "SoftLayer_Account::getReservedCapacityAgreements", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getReservedCapacityGroups": { + "get": { + "description": "The reserved capacity groups owned by this account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getReservedCapacityGroups/" + }, + "operationId": "SoftLayer_Account::getReservedCapacityGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_ReservedCapacityGroup" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getRouters": { + "get": { + "description": "All Routers that an accounts VLANs reside on", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getRouters/" + }, + "operationId": "SoftLayer_Account::getRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getRwhoisData": { + "get": { + "description": "DEPRECATED", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getRwhoisData/" + }, + "operationId": "SoftLayer_Account::getRwhoisData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Rwhois_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSamlAuthentication": { + "get": { + "description": "The SAML configuration for this account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSamlAuthentication/" + }, + "operationId": "SoftLayer_Account::getSamlAuthentication", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_Saml" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSecondaryDomains": { + "get": { + "description": "The secondary DNS records for a SoftLayer customer account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSecondaryDomains/" + }, + "operationId": "SoftLayer_Account::getSecondaryDomains", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Dns_Secondary" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSecurityCertificates": { + "get": { + "description": "Stored security certificates (ie. SSL)", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSecurityCertificates/" + }, + "operationId": "SoftLayer_Account::getSecurityCertificates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSecurityGroups": { + "get": { + "description": "The security groups belonging to this account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSecurityGroups/" + }, + "operationId": "SoftLayer_Account::getSecurityGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSecurityLevel": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSecurityLevel/" + }, + "operationId": "SoftLayer_Account::getSecurityLevel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Security_Level" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSecurityScanRequests": { + "get": { + "description": "An account's vulnerability scan requests.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSecurityScanRequests/" + }, + "operationId": "SoftLayer_Account::getSecurityScanRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Security_Scanner_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getServiceBillingItems": { + "get": { + "description": "The service billing items that will be on an account's next invoice. ", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getServiceBillingItems/" + }, + "operationId": "SoftLayer_Account::getServiceBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getShipments": { + "get": { + "description": "Shipments that belong to the customer's account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getShipments/" + }, + "operationId": "SoftLayer_Account::getShipments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSshKeys": { + "get": { + "description": "Customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSshKeys/" + }, + "operationId": "SoftLayer_Account::getSshKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSslVpnUsers": { + "get": { + "description": "An account's associated portal users with SSL VPN access.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSslVpnUsers/" + }, + "operationId": "SoftLayer_Account::getSslVpnUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getStandardPoolVirtualGuests": { + "get": { + "description": "An account's virtual guest objects that are hosted on a user provisioned hypervisor.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getStandardPoolVirtualGuests/" + }, + "operationId": "SoftLayer_Account::getStandardPoolVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSubnetRegistrationDetails": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSubnetRegistrationDetails/" + }, + "operationId": "SoftLayer_Account::getSubnetRegistrationDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSubnetRegistrations": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSubnetRegistrations/" + }, + "operationId": "SoftLayer_Account::getSubnetRegistrations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSubnets": { + "get": { + "description": "All network subnets associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSubnets/" + }, + "operationId": "SoftLayer_Account::getSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSupportRepresentatives": { + "get": { + "description": "The SoftLayer employees that an account is assigned to.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSupportRepresentatives/" + }, + "operationId": "SoftLayer_Account::getSupportRepresentatives", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Employee" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSupportSubscriptions": { + "get": { + "description": "The active support subscriptions for this account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSupportSubscriptions/" + }, + "operationId": "SoftLayer_Account::getSupportSubscriptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSupportTier": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSupportTier/" + }, + "operationId": "SoftLayer_Account::getSupportTier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getSuppressInvoicesFlag": { + "get": { + "description": "A flag indicating to suppress invoices.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getSuppressInvoicesFlag/" + }, + "operationId": "SoftLayer_Account::getSuppressInvoicesFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getTags": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getTags/" + }, + "operationId": "SoftLayer_Account::getTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getTestAccountAttributeFlag": { + "get": { + "description": "Account attribute flag indicating test account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getTestAccountAttributeFlag/" + }, + "operationId": "SoftLayer_Account::getTestAccountAttributeFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getTickets": { + "get": { + "description": "An account's associated tickets.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getTickets/" + }, + "operationId": "SoftLayer_Account::getTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getTicketsClosedInTheLastThreeDays": { + "get": { + "description": "Tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getTicketsClosedInTheLastThreeDays/" + }, + "operationId": "SoftLayer_Account::getTicketsClosedInTheLastThreeDays", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getTicketsClosedToday": { + "get": { + "description": "Tickets closed today associated with an account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getTicketsClosedToday/" + }, + "operationId": "SoftLayer_Account::getTicketsClosedToday", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getUpgradeRequests": { + "get": { + "description": "An account's associated upgrade requests.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getUpgradeRequests/" + }, + "operationId": "SoftLayer_Account::getUpgradeRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Upgrade_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getUsers": { + "get": { + "description": "An account's portal users.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getUsers/" + }, + "operationId": "SoftLayer_Account::getUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getValidSecurityCertificates": { + "get": { + "description": "Stored security certificates that are not expired (ie. SSL)", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getValidSecurityCertificates/" + }, + "operationId": "SoftLayer_Account::getValidSecurityCertificates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualDedicatedRacks": { + "get": { + "description": "The bandwidth pooling for this account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualDedicatedRacks/" + }, + "operationId": "SoftLayer_Account::getVirtualDedicatedRacks", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualDiskImages": { + "get": { + "description": "An account's associated virtual server virtual disk images.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualDiskImages/" + }, + "operationId": "SoftLayer_Account::getVirtualDiskImages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuests": { + "get": { + "description": "An account's associated virtual guest objects.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuests/" + }, + "operationId": "SoftLayer_Account::getVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuestsOverBandwidthAllocation": { + "get": { + "description": "An account's associated virtual guest objects currently over bandwidth allocation.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuestsOverBandwidthAllocation/" + }, + "operationId": "SoftLayer_Account::getVirtualGuestsOverBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuestsProjectedOverBandwidthAllocation": { + "get": { + "description": "An account's associated virtual guest objects currently over bandwidth allocation.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuestsProjectedOverBandwidthAllocation/" + }, + "operationId": "SoftLayer_Account::getVirtualGuestsProjectedOverBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuestsWithCpanel": { + "get": { + "description": "All virtual guests associated with an account that has the cPanel web hosting control panel installed.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuestsWithCpanel/" + }, + "operationId": "SoftLayer_Account::getVirtualGuestsWithCpanel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuestsWithMcafee": { + "get": { + "description": "All virtual guests associated with an account that have McAfee Secure software components.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafee/" + }, + "operationId": "SoftLayer_Account::getVirtualGuestsWithMcafee", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusRedhat": { + "get": { + "description": "All virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusRedhat/" + }, + "operationId": "SoftLayer_Account::getVirtualGuestsWithMcafeeAntivirusRedhat", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusWindows": { + "get": { + "description": "All virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusWindows/" + }, + "operationId": "SoftLayer_Account::getVirtualGuestsWithMcafeeAntivirusWindows", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuestsWithMcafeeIntrusionDetectionSystem": { + "get": { + "description": "All virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeIntrusionDetectionSystem/" + }, + "operationId": "SoftLayer_Account::getVirtualGuestsWithMcafeeIntrusionDetectionSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuestsWithPlesk": { + "get": { + "description": "All virtual guests associated with an account that has the Plesk web hosting control panel installed.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuestsWithPlesk/" + }, + "operationId": "SoftLayer_Account::getVirtualGuestsWithPlesk", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuestsWithQuantastor": { + "get": { + "description": "All virtual guests associated with an account that have the QuantaStor storage system installed.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuestsWithQuantastor/" + }, + "operationId": "SoftLayer_Account::getVirtualGuestsWithQuantastor", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualGuestsWithUrchin": { + "get": { + "description": "All virtual guests associated with an account that has the Urchin web traffic analytics package installed.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualGuestsWithUrchin/" + }, + "operationId": "SoftLayer_Account::getVirtualGuestsWithUrchin", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualPrivateRack": { + "get": { + "description": "The bandwidth pooling for this account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualPrivateRack/" + }, + "operationId": "SoftLayer_Account::getVirtualPrivateRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualStorageArchiveRepositories": { + "get": { + "description": "An account's associated virtual server archived storage repositories.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualStorageArchiveRepositories/" + }, + "operationId": "SoftLayer_Account::getVirtualStorageArchiveRepositories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Storage_Repository" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVirtualStoragePublicRepositories": { + "get": { + "description": "An account's associated virtual server public storage repositories.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVirtualStoragePublicRepositories/" + }, + "operationId": "SoftLayer_Account::getVirtualStoragePublicRepositories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Storage_Repository" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVpcVirtualGuests": { + "get": { + "description": "An account's associated VPC configured virtual guest objects.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVpcVirtualGuests/" + }, + "operationId": "SoftLayer_Account::getVpcVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account/getVpnConfigRequiresVPNManageFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getVpnConfigRequiresVPNManageFlag/" + }, + "operationId": "SoftLayer_Account::getVpnConfigRequiresVPNManageFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account_Address/createObject": { + "post": { + "description": "Create a new address record. The ''typeId'', ''accountId'', ''description'', ''address1'', ''city'', ''state'', ''country'', and ''postalCode'' properties in the templateObject parameter are required properties and may not be null or empty. Users will be restricted to creating addresses for their account. ", + "summary": "Create a new address record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/createObject/" + }, + "operationId": "SoftLayer_Account_Address::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account_Address::createObject::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account_Address::createObject::Parameters::Input", + "properties": { + "templateObject": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/editObject": { + "post": { + "description": "Edit the properties of an address record by passing in a modified instance of a SoftLayer_Account_Address object. Users will be restricted to modifying addresses for their account. ", + "summary": "Edit an address record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/editObject/" + }, + "operationId": "SoftLayer_Account_Address::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account_Address::editObject::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account_Address::editObject::Parameters::Input", + "properties": { + "templateObject": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + } + } + } + }, + "parameters": [ + { + "name": "SoftLayer_Account_AddressID", + "in": "path", + "description": "ID for a SoftLayer_Account_Address object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Address/getAllDataCenters": { + "get": { + "description": "Retrieve a list of SoftLayer datacenter addresses.", + "summary": "Retrieve a list of SoftLayer datacenter addresses.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/getAllDataCenters/" + }, + "operationId": "SoftLayer_Account_Address::getAllDataCenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account_Address/getNetworkAddress": { + "post": { + "description": "Retrieve a list of SoftLayer datacenter addresses.", + "summary": "Retrieve a list of SoftLayer datacenter addresses.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/getNetworkAddress/" + }, + "operationId": "SoftLayer_Account_Address::getNetworkAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account_Address::getNetworkAddress::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account_Address::getNetworkAddress::Parameters::Input", + "properties": { + "name": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Address record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/getObject/" + }, + "operationId": "SoftLayer_Account_Address::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AddressID", + "in": "path", + "description": "ID for a SoftLayer_Account_Address object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getAccount": { + "get": { + "description": "The account to which this address belongs.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/getAccount/" + }, + "operationId": "SoftLayer_Account_Address::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AddressID", + "in": "path", + "description": "ID for a SoftLayer_Account_Address object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getCreateUser": { + "get": { + "description": "The customer user who created this address.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/getCreateUser/" + }, + "operationId": "SoftLayer_Account_Address::getCreateUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AddressID", + "in": "path", + "description": "ID for a SoftLayer_Account_Address object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getLocation": { + "get": { + "description": "The location of this address.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/getLocation/" + }, + "operationId": "SoftLayer_Account_Address::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AddressID", + "in": "path", + "description": "ID for a SoftLayer_Account_Address object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getModifyEmployee": { + "get": { + "description": "The employee who last modified this address.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/getModifyEmployee/" + }, + "operationId": "SoftLayer_Account_Address::getModifyEmployee", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Employee" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AddressID", + "in": "path", + "description": "ID for a SoftLayer_Account_Address object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getModifyUser": { + "get": { + "description": "The customer user who last modified this address.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/getModifyUser/" + }, + "operationId": "SoftLayer_Account_Address::getModifyUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AddressID", + "in": "path", + "description": "ID for a SoftLayer_Account_Address object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getType": { + "get": { + "description": "An account address' type.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address/getType/" + }, + "operationId": "SoftLayer_Account_Address::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Address_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AddressID", + "in": "path", + "description": "ID for a SoftLayer_Account_Address object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Address_Type/{SoftLayer_Account_Address_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Address_Type record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Address_Type/getObject/" + }, + "operationId": "SoftLayer_Account_Address_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Address_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Address_TypeID", + "in": "path", + "description": "ID for a SoftLayer_Account_Address_Type object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Affiliation/createObject": { + "post": { + "description": "Create a new affiliation to associate with an existing account. ", + "summary": "Create a new affiliation.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Affiliation/createObject/" + }, + "operationId": "SoftLayer_Account_Affiliation::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Affiliation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account_Affiliation::createObject::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account_Affiliation::createObject::Parameters::Input", + "properties": { + "templateObject": { + "$ref": "#/components/schemas/SoftLayer_Account_Affiliation" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account_Affiliation/{SoftLayer_Account_AffiliationID}/deleteObject": { + "get": { + "description": "deleteObject permanently removes an account affiliation ", + "summary": "Delete an account affiliation", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Affiliation/deleteObject/" + }, + "operationId": "SoftLayer_Account_Affiliation::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AffiliationID", + "in": "path", + "description": "ID for a SoftLayer_Account_Affiliation object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Affiliation/{SoftLayer_Account_AffiliationID}/editObject": { + "post": { + "description": "Edit an affiliation that is associated to an existing account. ", + "summary": "Update an account affiliation information.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Affiliation/editObject/" + }, + "operationId": "SoftLayer_Account_Affiliation::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account_Affiliation::editObject::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account_Affiliation::editObject::Parameters::Input", + "properties": { + "templateObject": { + "$ref": "#/components/schemas/SoftLayer_Account_Affiliation" + } + } + } + } + } + } + } + }, + "parameters": [ + { + "name": "SoftLayer_Account_AffiliationID", + "in": "path", + "description": "ID for a SoftLayer_Account_Affiliation object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Affiliation/getAccountAffiliationsByAffiliateId": { + "post": { + "description": "Get account affiliation information associated with affiliate id. ", + "summary": "Get account affiliation information associated with affiliate id.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Affiliation/getAccountAffiliationsByAffiliateId/" + }, + "operationId": "SoftLayer_Account_Affiliation::getAccountAffiliationsByAffiliateId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Affiliation" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account_Affiliation::getAccountAffiliationsByAffiliateId::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account_Affiliation::getAccountAffiliationsByAffiliateId::Parameters::Input", + "properties": { + "affiliateId": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account_Affiliation/{SoftLayer_Account_AffiliationID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Affiliation record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Affiliation/getObject/" + }, + "operationId": "SoftLayer_Account_Affiliation::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Affiliation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AffiliationID", + "in": "path", + "description": "ID for a SoftLayer_Account_Affiliation object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Affiliation/{SoftLayer_Account_AffiliationID}/getAccount": { + "get": { + "description": "The account that an affiliation belongs to.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Affiliation/getAccount/" + }, + "operationId": "SoftLayer_Account_Affiliation::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AffiliationID", + "in": "path", + "description": "ID for a SoftLayer_Account_Affiliation object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Agreement record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Agreement/getObject/" + }, + "operationId": "SoftLayer_Account_Agreement::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AgreementID", + "in": "path", + "description": "ID for a SoftLayer_Account_Agreement object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Agreement/getAccount/" + }, + "operationId": "SoftLayer_Account_Agreement::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AgreementID", + "in": "path", + "description": "ID for a SoftLayer_Account_Agreement object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getAgreementType": { + "get": { + "description": "The type of agreement.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Agreement/getAgreementType/" + }, + "operationId": "SoftLayer_Account_Agreement::getAgreementType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AgreementID", + "in": "path", + "description": "ID for a SoftLayer_Account_Agreement object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getAttachedBillingAgreementFiles": { + "get": { + "description": "The files attached to an agreement.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Agreement/getAttachedBillingAgreementFiles/" + }, + "operationId": "SoftLayer_Account_Agreement::getAttachedBillingAgreementFiles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_MasterServiceAgreement" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AgreementID", + "in": "path", + "description": "ID for a SoftLayer_Account_Agreement object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getBillingItems": { + "get": { + "description": "The billing items associated with an agreement.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Agreement/getBillingItems/" + }, + "operationId": "SoftLayer_Account_Agreement::getBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AgreementID", + "in": "path", + "description": "ID for a SoftLayer_Account_Agreement object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getStatus": { + "get": { + "description": "The status of the agreement.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Agreement/getStatus/" + }, + "operationId": "SoftLayer_Account_Agreement::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AgreementID", + "in": "path", + "description": "ID for a SoftLayer_Account_Agreement object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getTopLevelBillingItems": { + "get": { + "description": "The top level billing item associated with an agreement.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Agreement/getTopLevelBillingItems/" + }, + "operationId": "SoftLayer_Account_Agreement::getTopLevelBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_AgreementID", + "in": "path", + "description": "ID for a SoftLayer_Account_Agreement object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Attribute/{SoftLayer_Account_Authentication_AttributeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Authentication_Attribute record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Attribute/getObject/" + }, + "operationId": "SoftLayer_Account_Authentication_Attribute::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_AttributeID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Attribute object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Attribute/{SoftLayer_Account_Authentication_AttributeID}/getAccount": { + "get": { + "description": "The SoftLayer customer account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Attribute/getAccount/" + }, + "operationId": "SoftLayer_Account_Authentication_Attribute::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_AttributeID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Attribute object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Attribute/{SoftLayer_Account_Authentication_AttributeID}/getAuthenticationRecord": { + "get": { + "description": "The SoftLayer account authentication that has an attribute.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Attribute/getAuthenticationRecord/" + }, + "operationId": "SoftLayer_Account_Authentication_Attribute::getAuthenticationRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_Saml" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_AttributeID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Attribute object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Attribute/{SoftLayer_Account_Authentication_AttributeID}/getType": { + "get": { + "description": "The type of attribute assigned to a SoftLayer account authentication.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Attribute/getType/" + }, + "operationId": "SoftLayer_Account_Authentication_Attribute::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_Attribute_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_AttributeID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Attribute object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Attribute_Type/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getAllObjects/" + }, + "operationId": "SoftLayer_Account_Authentication_Attribute_Type::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Attribute_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/SoftLayer_Account_Authentication_Attribute_Type/{SoftLayer_Account_Authentication_Attribute_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Authentication_Attribute_Type record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getObject/" + }, + "operationId": "SoftLayer_Account_Authentication_Attribute_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_Attribute_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_Attribute_TypeID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Attribute_Type object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Saml/createObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Saml/createObject/" + }, + "operationId": "SoftLayer_Account_Authentication_Saml::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_Saml" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account_Authentication_Saml::createObject::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account_Authentication_Saml::createObject::Parameters::Input", + "properties": { + "templateObject": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_Saml" + } + } + } + } + } + } + } + } + } + }, + "/SoftLayer_Account_Authentication_Saml/{SoftLayer_Account_Authentication_SamlID}/deleteObject": { + "get": { + "description": null, + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Saml/deleteObject/" + }, + "operationId": "SoftLayer_Account_Authentication_Saml::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_SamlID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Saml object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Saml/{SoftLayer_Account_Authentication_SamlID}/editObject": { + "post": { + "description": "Edit the object by passing in a modified instance of the object ", + "summary": "Edit the object by passing in a modified instance of the object.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Saml/editObject/" + }, + "operationId": "SoftLayer_Account_Authentication_Saml::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "requestBody": { + "description": "POST parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "SoftLayer_Account_Authentication_Saml::editObject::Parameters", + "properties": { + "parameters": { + "type": "object", + "title": "SoftLayer_Account_Authentication_Saml::editObject::Parameters::Input", + "properties": { + "templateObject": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_Saml" + } + } + } + } + } + } + } + }, + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_SamlID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Saml object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Saml/{SoftLayer_Account_Authentication_SamlID}/getMetadata": { + "get": { + "description": "This method will return the service provider metadata in XML format. ", + "summary": "Get the service provider meta data.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Saml/getMetadata/" + }, + "operationId": "SoftLayer_Account_Authentication_Saml::getMetadata", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_SamlID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Saml object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Saml/{SoftLayer_Account_Authentication_SamlID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Authentication_Saml record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Saml/getObject/" + }, + "operationId": "SoftLayer_Account_Authentication_Saml::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_Saml" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_SamlID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Saml object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Saml/{SoftLayer_Account_Authentication_SamlID}/getAccount": { + "get": { + "description": "The account associated with this saml configuration.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Saml/getAccount/" + }, + "operationId": "SoftLayer_Account_Authentication_Saml::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_SamlID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Saml object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Authentication_Saml/{SoftLayer_Account_Authentication_SamlID}/getAttributes": { + "get": { + "description": "The saml attribute values for a SoftLayer customer account.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Authentication_Saml/getAttributes/" + }, + "operationId": "SoftLayer_Account_Authentication_Saml::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Authentication_SamlID", + "in": "path", + "description": "ID for a SoftLayer_Account_Authentication_Saml object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Brand_Migration_Request/{SoftLayer_Account_Brand_Migration_RequestID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Brand_Migration_Request record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Brand_Migration_Request/getObject/" + }, + "operationId": "SoftLayer_Account_Brand_Migration_Request::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Brand_Migration_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Brand_Migration_RequestID", + "in": "path", + "description": "ID for a SoftLayer_Account_Brand_Migration_Request object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Brand_Migration_Request/{SoftLayer_Account_Brand_Migration_RequestID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Brand_Migration_Request/getAccount/" + }, + "operationId": "SoftLayer_Account_Brand_Migration_Request::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Brand_Migration_RequestID", + "in": "path", + "description": "ID for a SoftLayer_Account_Brand_Migration_Request object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Brand_Migration_Request/{SoftLayer_Account_Brand_Migration_RequestID}/getDestinationBrand": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Brand_Migration_Request/getDestinationBrand/" + }, + "operationId": "SoftLayer_Account_Brand_Migration_Request::getDestinationBrand", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Brand_Migration_RequestID", + "in": "path", + "description": "ID for a SoftLayer_Account_Brand_Migration_Request object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Brand_Migration_Request/{SoftLayer_Account_Brand_Migration_RequestID}/getSourceBrand": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Brand_Migration_Request/getSourceBrand/" + }, + "operationId": "SoftLayer_Account_Brand_Migration_Request::getSourceBrand", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Brand_Migration_RequestID", + "in": "path", + "description": "ID for a SoftLayer_Account_Brand_Migration_Request object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Brand_Migration_Request/{SoftLayer_Account_Brand_Migration_RequestID}/getUser": { + "get": { + "description": "", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Brand_Migration_Request/getUser/" + }, + "operationId": "SoftLayer_Account_Brand_Migration_Request::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Brand_Migration_RequestID", + "in": "path", + "description": "ID for a SoftLayer_Account_Brand_Migration_Request object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Business_Partner/{SoftLayer_Account_Business_PartnerID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Business_Partner record.", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Business_Partner/getObject/" + }, + "operationId": "SoftLayer_Account_Business_Partner::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Business_Partner" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Business_PartnerID", + "in": "path", + "description": "ID for a SoftLayer_Account_Business_Partner object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Business_Partner/{SoftLayer_Account_Business_PartnerID}/getAccount": { + "get": { + "description": "Account associated with the business partner data", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Business_Partner/getAccount/" + }, + "operationId": "SoftLayer_Account_Business_Partner::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Business_PartnerID", + "in": "path", + "description": "ID for a SoftLayer_Account_Business_Partner object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Business_Partner/{SoftLayer_Account_Business_PartnerID}/getChannel": { + "get": { + "description": "Channel indicator used to categorize business partner revenue.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Business_Partner/getChannel/" + }, + "operationId": "SoftLayer_Account_Business_Partner::getChannel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Business_Partner_Channel" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Business_PartnerID", + "in": "path", + "description": "ID for a SoftLayer_Account_Business_Partner object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Business_Partner/{SoftLayer_Account_Business_PartnerID}/getSegment": { + "get": { + "description": "Segment indicator used to categorize business partner revenue.", + "summary": "", + "externalDocs": { + "description": "SLDN Documentation", + "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Business_Partner/getSegment/" + }, + "operationId": "SoftLayer_Account_Business_Partner::getSegment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Business_Partner_Segment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ], + "parameters": [ + { + "name": "SoftLayer_Account_Business_PartnerID", + "in": "path", + "description": "ID for a SoftLayer_Account_Business_Partner object", + "required": true, + "schema": { + "type": "integer" + } + } + ] + } + }, + "/SoftLayer_Account_Contact/createComplianceReportRequestorContact": { + "post": { + "description": "<
detailTypeIdThe [[SoftLayer_Account_Regional_Registry_Detail_Type|type id]] of this detail object- Required
- Type - integer
regionalInternetRegistryHandleIdThe id of the [[SoftLayer_Account_Rwhois_Handle|RWhois handle]] object. This is only to be used for detailed registrations, where a subnet is registered to an organization. The associated handle will be required to be a valid organization object id at the relevant registry. In this case, the detail object will only be valid for the registry the organization belongs to.- Optional
- Type - integer
registrationDetailIdThe numeric ID of the [[SoftLayer_Account_Regional_Registry_Detail|detail object]] this property belongs to- Required
- Type - integer
propertyTypeIdThe numeric ID of the associated [[SoftLayer_Account_Regional_Registry_Detail_Property_Type]] object- Required
- Type - integer
sequencePositionWhen more than one property of the same type exists on a detail object, this value determines the position in that collection. This can be thought of more as a sort order.- Required
- Type - integer
valueThe actual value of the property.- Required
- Type - string
provisionDate property. \nWhen provisionDate is not null, the server will be ready. Be sure to use the globalIdentifier \nas your initialization parameter. \n\n\nWarning: Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]]. \n\n\nInput - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]] \n- \n
hostname\nHostname for the server.- \n
- Required \n
- Type - string \n
\n \n domain\nDomain for the server.- \n
- Required \n
- Type - string \n
\n \n processorCoreAmount\nThe number of logical CPU cores to allocate.- \n
- Required \n
- Type - int \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n memoryCapacity\nThe amount of memory to allocate in gigabytes.- \n
- Required \n
- Type - int \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n hourlyBillingFlag\nSpecifies the billing type for the server.- \n
- Required \n
- Type - boolean \n
- When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis. \n
\n \n operatingSystemReferenceCode\nAn identifier for the operating system to provision the server with.- \n
- Required \n
- Type - string \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n datacenter.name\nSpecifies which datacenter the server is to be provisioned in.- \n
- Required \n
- Type - string \n
- The
datacenterproperty is a [[SoftLayer_Location (type)|location]] structure with thenamefield set. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"datacenter\": { \n \"name\": \"dal05\" \n } \n} \n
\n \n networkComponents.maxSpeed\nSpecifies the connection speed for the server's network components.- \n
- Optional \n
- Type - int \n
- Default - The highest available zero cost port speed will be used. \n
- Description - The
networkComponentsproperty is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. ThemaxSpeedproperty must be set to specify the network uplink speed, in megabits per second, of the server. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"networkComponents\": [ \n { \n \"maxSpeed\": 1000 \n } \n ] \n} \n
\n \n networkComponents.redundancyEnabledFlag\nSpecifies whether or not the server's network components should be in redundancy groups.- \n
- Optional \n
- Type - bool \n
- Default -
false \n - Description - The
networkComponentsproperty is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When theredundancyEnabledFlagproperty is true the server's network components will be in redundancy groups. \n
{ \n \"networkComponents\": [ \n { \n \"redundancyEnabledFlag\": false \n } \n ] \n} \n
\n \n privateNetworkOnlyFlag\nSpecifies whether or not the server only has access to the private network- \n
- Optional \n
- Type - boolean \n
- Default -
false \n - When true this flag specifies that a server is to only have access to the private network. \n
\n \n primaryNetworkComponent.networkVlan.id\nSpecifies the network vlan which is to be used for the frontend interface of the server.- \n
- Optional \n
- Type - int \n
- Description - The
primaryNetworkComponentproperty is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlanproperty populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theidproperty must be set to specify the frontend network vlan of the server. \n
{ \n \"primaryNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 1 \n } \n } \n} \n
\n \n primaryBackendNetworkComponent.networkVlan.id\nSpecifies the network vlan which is to be used for the backend interface of the server.- \n
- Optional \n
- Type - int \n
- Description - The
primaryBackendNetworkComponentproperty is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlanproperty populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theidproperty must be set to specify the backend network vlan of the server. \n
{ \n \"primaryBackendNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 2 \n } \n } \n} \n
\n \n fixedConfigurationPreset.keyName\n- \n
- Optional \n
- Type - string \n
- Description - The
fixedConfigurationPresetproperty is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. ThekeyNameproperty must be set to specify preset to use. \n - If a fixed configuration preset is used
processorCoreAmount,memoryCapacityandhardDrivesproperties must not be set. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"fixedConfigurationPreset\": { \n \"keyName\": \"SOME_KEY_NAME\" \n } \n} \n
\n \n userData.value\nArbitrary data to be made available to the server.- \n
- Optional \n
- Type - string \n
- Description - The
userDataproperty is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with thevalueproperty set to an arbitrary value. \n - This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot. \n
{ \n \"userData\": [ \n { \n \"value\": \"someValue\" \n } \n ] \n} \n
\n \n hardDrives\nHard drive settings for the server- \n
- Optional \n
- Type - SoftLayer_Hardware_Component \n
- Default - The largest available capacity for a zero cost primary disk will be used. \n
- Description - The
hardDrivesproperty is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures. \n - Each hard drive must specify the
capacityproperty. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"hardDrives\": [ \n { \n \"capacity\": 500 \n } \n ] \n} \n
\n \n sshKeys\nSSH keys to install on the server upon provisioning.- \n
- Optional \n
- Type - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]] \n
- Description - The
sshKeysproperty is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with theidproperty set to the value of an existing SSH key. \n - To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service. \n
- To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service. \n
{ \n \"sshKeys\": [ \n { \n \"id\": 123 \n } \n ] \n} \n
\n \n postInstallScriptUri\nSpecifies the uri location of the script to be downloaded and run after installation is complete.- \n
- Optional \n
- Type - string \n
\n \n
REST Example
\nprovisionDate property. \nWhen provisionDate is not null, the server will be ready. Be sure to use the globalIdentifier \nas your initialization parameter. \n\n\nWarning: Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]]. \n\n\nInput - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]] \n- \n
hostname\nHostname for the server.- \n
- Required \n
- Type - string \n
\n \n domain\nDomain for the server.- \n
- Required \n
- Type - string \n
\n \n processorCoreAmount\nThe number of logical CPU cores to allocate.- \n
- Required \n
- Type - int \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n memoryCapacity\nThe amount of memory to allocate in gigabytes.- \n
- Required \n
- Type - int \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n hourlyBillingFlag\nSpecifies the billing type for the server.- \n
- Required \n
- Type - boolean \n
- When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis. \n
\n \n operatingSystemReferenceCode\nAn identifier for the operating system to provision the server with.- \n
- Required \n
- Type - string \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n datacenter.name\nSpecifies which datacenter the server is to be provisioned in.- \n
- Required \n
- Type - string \n
- The
datacenterproperty is a [[SoftLayer_Location (type)|location]] structure with thenamefield set. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"datacenter\": { \n \"name\": \"dal05\" \n } \n} \n
\n \n networkComponents.maxSpeed\nSpecifies the connection speed for the server's network components.- \n
- Optional \n
- Type - int \n
- Default - The highest available zero cost port speed will be used. \n
- Description - The
networkComponentsproperty is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. ThemaxSpeedproperty must be set to specify the network uplink speed, in megabits per second, of the server. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"networkComponents\": [ \n { \n \"maxSpeed\": 1000 \n } \n ] \n} \n
\n \n networkComponents.redundancyEnabledFlag\nSpecifies whether or not the server's network components should be in redundancy groups.- \n
- Optional \n
- Type - bool \n
- Default -
false \n - Description - The
networkComponentsproperty is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When theredundancyEnabledFlagproperty is true the server's network components will be in redundancy groups. \n
{ \n \"networkComponents\": [ \n { \n \"redundancyEnabledFlag\": false \n } \n ] \n} \n
\n \n privateNetworkOnlyFlag\nSpecifies whether or not the server only has access to the private network- \n
- Optional \n
- Type - boolean \n
- Default -
false \n - When true this flag specifies that a server is to only have access to the private network. \n
\n \n primaryNetworkComponent.networkVlan.id\nSpecifies the network vlan which is to be used for the frontend interface of the server.- \n
- Optional \n
- Type - int \n
- Description - The
primaryNetworkComponentproperty is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlanproperty populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theidproperty must be set to specify the frontend network vlan of the server. \n
{ \n \"primaryNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 1 \n } \n } \n} \n
\n \n primaryBackendNetworkComponent.networkVlan.id\nSpecifies the network vlan which is to be used for the backend interface of the server.- \n
- Optional \n
- Type - int \n
- Description - The
primaryBackendNetworkComponentproperty is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlanproperty populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theidproperty must be set to specify the backend network vlan of the server. \n
{ \n \"primaryBackendNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 2 \n } \n } \n} \n
\n \n fixedConfigurationPreset.keyName\n- \n
- Optional \n
- Type - string \n
- Description - The
fixedConfigurationPresetproperty is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. ThekeyNameproperty must be set to specify preset to use. \n - If a fixed configuration preset is used
processorCoreAmount,memoryCapacityandhardDrivesproperties must not be set. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"fixedConfigurationPreset\": { \n \"keyName\": \"SOME_KEY_NAME\" \n } \n} \n
\n \n userData.value\nArbitrary data to be made available to the server.- \n
- Optional \n
- Type - string \n
- Description - The
userDataproperty is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with thevalueproperty set to an arbitrary value. \n - This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot. \n
{ \n \"userData\": [ \n { \n \"value\": \"someValue\" \n } \n ] \n} \n
\n \n hardDrives\nHard drive settings for the server- \n
- Optional \n
- Type - SoftLayer_Hardware_Component \n
- Default - The largest available capacity for a zero cost primary disk will be used. \n
- Description - The
hardDrivesproperty is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures. \n - Each hard drive must specify the
capacityproperty. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"hardDrives\": [ \n { \n \"capacity\": 500 \n } \n ] \n} \n
\n \n sshKeys\nSSH keys to install on the server upon provisioning.- \n
- Optional \n
- Type - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]] \n
- Description - The
sshKeysproperty is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with theidproperty set to the value of an existing SSH key. \n - To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service. \n
- To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service. \n
{ \n \"sshKeys\": [ \n { \n \"id\": 123 \n } \n ] \n} \n
\n \n postInstallScriptUri\nSpecifies the uri location of the script to be downloaded and run after installation is complete.- \n
- Optional \n
- Type - string \n
\n \n
REST Example
\nprovisionDate property. \nWhen provisionDate is not null, the server will be ready. Be sure to use the globalIdentifier \nas your initialization parameter. \n\n\nWarning: Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]]. \n\n\nInput - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]] \n- \n
hostname\nHostname for the server.- \n
- Required \n
- Type - string \n
\n \n domain\nDomain for the server.- \n
- Required \n
- Type - string \n
\n \n processorCoreAmount\nThe number of logical CPU cores to allocate.- \n
- Required \n
- Type - int \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n memoryCapacity\nThe amount of memory to allocate in gigabytes.- \n
- Required \n
- Type - int \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n hourlyBillingFlag\nSpecifies the billing type for the server.- \n
- Required \n
- Type - boolean \n
- When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis. \n
\n \n operatingSystemReferenceCode\nAn identifier for the operating system to provision the server with.- \n
- Required \n
- Type - string \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n datacenter.name\nSpecifies which datacenter the server is to be provisioned in.- \n
- Required \n
- Type - string \n
- The
datacenterproperty is a [[SoftLayer_Location (type)|location]] structure with thenamefield set. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"datacenter\": { \n \"name\": \"dal05\" \n } \n} \n
\n \n networkComponents.maxSpeed\nSpecifies the connection speed for the server's network components.- \n
- Optional \n
- Type - int \n
- Default - The highest available zero cost port speed will be used. \n
- Description - The
networkComponentsproperty is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. ThemaxSpeedproperty must be set to specify the network uplink speed, in megabits per second, of the server. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"networkComponents\": [ \n { \n \"maxSpeed\": 1000 \n } \n ] \n} \n
\n \n networkComponents.redundancyEnabledFlag\nSpecifies whether or not the server's network components should be in redundancy groups.- \n
- Optional \n
- Type - bool \n
- Default -
false \n - Description - The
networkComponentsproperty is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When theredundancyEnabledFlagproperty is true the server's network components will be in redundancy groups. \n
{ \n \"networkComponents\": [ \n { \n \"redundancyEnabledFlag\": false \n } \n ] \n} \n
\n \n privateNetworkOnlyFlag\nSpecifies whether or not the server only has access to the private network- \n
- Optional \n
- Type - boolean \n
- Default -
false \n - When true this flag specifies that a server is to only have access to the private network. \n
\n \n primaryNetworkComponent.networkVlan.id\nSpecifies the network vlan which is to be used for the frontend interface of the server.- \n
- Optional \n
- Type - int \n
- Description - The
primaryNetworkComponentproperty is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlanproperty populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theidproperty must be set to specify the frontend network vlan of the server. \n
{ \n \"primaryNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 1 \n } \n } \n} \n
\n \n primaryBackendNetworkComponent.networkVlan.id\nSpecifies the network vlan which is to be used for the backend interface of the server.- \n
- Optional \n
- Type - int \n
- Description - The
primaryBackendNetworkComponentproperty is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlanproperty populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theidproperty must be set to specify the backend network vlan of the server. \n
{ \n \"primaryBackendNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 2 \n } \n } \n} \n
\n \n fixedConfigurationPreset.keyName\n- \n
- Optional \n
- Type - string \n
- Description - The
fixedConfigurationPresetproperty is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. ThekeyNameproperty must be set to specify preset to use. \n - If a fixed configuration preset is used
processorCoreAmount,memoryCapacityandhardDrivesproperties must not be set. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"fixedConfigurationPreset\": { \n \"keyName\": \"SOME_KEY_NAME\" \n } \n} \n
\n \n userData.value\nArbitrary data to be made available to the server.- \n
- Optional \n
- Type - string \n
- Description - The
userDataproperty is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with thevalueproperty set to an arbitrary value. \n - This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot. \n
{ \n \"userData\": [ \n { \n \"value\": \"someValue\" \n } \n ] \n} \n
\n \n hardDrives\nHard drive settings for the server- \n
- Optional \n
- Type - SoftLayer_Hardware_Component \n
- Default - The largest available capacity for a zero cost primary disk will be used. \n
- Description - The
hardDrivesproperty is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures. \n - Each hard drive must specify the
capacityproperty. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"hardDrives\": [ \n { \n \"capacity\": 500 \n } \n ] \n} \n
\n \n sshKeys\nSSH keys to install on the server upon provisioning.- \n
- Optional \n
- Type - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]] \n
- Description - The
sshKeysproperty is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with theidproperty set to the value of an existing SSH key. \n - To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service. \n
- To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service. \n
{ \n \"sshKeys\": [ \n { \n \"id\": 123 \n } \n ] \n} \n
\n \n postInstallScriptUri\nSpecifies the uri location of the script to be downloaded and run after installation is complete.- \n
- Optional \n
- Type - string \n
\n \n
REST Example
\nBackwards Compatibility Until February 27th, 2019
\n\nIn order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period.- A \"doubled\" (eg. 200) speed value will be translated to a redundancy value of \"redundant\". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.
- A non-doubled (eg. 100) speed value without a redundancy value will be translated to a redundancy value of \"degraded\".
Backwards Compatibility Until February 27th, 2019
\n\nIn order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period.- A \"doubled\" (eg. 200) speed value will be translated to a redundancy value of \"redundant\". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.
- A non-doubled (eg. 100) speed value without a redundancy value will be translated to a redundancy value of \"degraded\".
provisionDate property. \nWhen provisionDate is not null, the server will be ready. Be sure to use the globalIdentifier \nas your initialization parameter. \n\n\nWarning: Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]]. \n\n\nInput - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]] \n- \n
hostname\nHostname for the server.- \n
- Required \n
- Type - string \n
\n \n domain\nDomain for the server.- \n
- Required \n
- Type - string \n
\n \n processorCoreAmount\nThe number of logical CPU cores to allocate.- \n
- Required \n
- Type - int \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n memoryCapacity\nThe amount of memory to allocate in gigabytes.- \n
- Required \n
- Type - int \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n hourlyBillingFlag\nSpecifies the billing type for the server.- \n
- Required \n
- Type - boolean \n
- When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis. \n
\n \n operatingSystemReferenceCode\nAn identifier for the operating system to provision the server with.- \n
- Required \n
- Type - string \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n datacenter.name\nSpecifies which datacenter the server is to be provisioned in.- \n
- Required \n
- Type - string \n
- The
datacenterproperty is a [[SoftLayer_Location (type)|location]] structure with thenamefield set. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"datacenter\": { \n \"name\": \"dal05\" \n } \n} \n
\n \n networkComponents.maxSpeed\nSpecifies the connection speed for the server's network components.- \n
- Optional \n
- Type - int \n
- Default - The highest available zero cost port speed will be used. \n
- Description - The
networkComponentsproperty is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. ThemaxSpeedproperty must be set to specify the network uplink speed, in megabits per second, of the server. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"networkComponents\": [ \n { \n \"maxSpeed\": 1000 \n } \n ] \n} \n
\n \n networkComponents.redundancyEnabledFlag\nSpecifies whether or not the server's network components should be in redundancy groups.- \n
- Optional \n
- Type - bool \n
- Default -
false \n - Description - The
networkComponentsproperty is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When theredundancyEnabledFlagproperty is true the server's network components will be in redundancy groups. \n
{ \n \"networkComponents\": [ \n { \n \"redundancyEnabledFlag\": false \n } \n ] \n} \n
\n \n privateNetworkOnlyFlag\nSpecifies whether or not the server only has access to the private network- \n
- Optional \n
- Type - boolean \n
- Default -
false \n - When true this flag specifies that a server is to only have access to the private network. \n
\n \n primaryNetworkComponent.networkVlan.id\nSpecifies the network vlan which is to be used for the frontend interface of the server.- \n
- Optional \n
- Type - int \n
- Description - The
primaryNetworkComponentproperty is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlanproperty populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theidproperty must be set to specify the frontend network vlan of the server. \n
{ \n \"primaryNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 1 \n } \n } \n} \n
\n \n primaryBackendNetworkComponent.networkVlan.id\nSpecifies the network vlan which is to be used for the backend interface of the server.- \n
- Optional \n
- Type - int \n
- Description - The
primaryBackendNetworkComponentproperty is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlanproperty populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theidproperty must be set to specify the backend network vlan of the server. \n
{ \n \"primaryBackendNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 2 \n } \n } \n} \n
\n \n fixedConfigurationPreset.keyName\n- \n
- Optional \n
- Type - string \n
- Description - The
fixedConfigurationPresetproperty is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. ThekeyNameproperty must be set to specify preset to use. \n - If a fixed configuration preset is used
processorCoreAmount,memoryCapacityandhardDrivesproperties must not be set. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"fixedConfigurationPreset\": { \n \"keyName\": \"SOME_KEY_NAME\" \n } \n} \n
\n \n userData.value\nArbitrary data to be made available to the server.- \n
- Optional \n
- Type - string \n
- Description - The
userDataproperty is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with thevalueproperty set to an arbitrary value. \n - This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot. \n
{ \n \"userData\": [ \n { \n \"value\": \"someValue\" \n } \n ] \n} \n
\n \n hardDrives\nHard drive settings for the server- \n
- Optional \n
- Type - SoftLayer_Hardware_Component \n
- Default - The largest available capacity for a zero cost primary disk will be used. \n
- Description - The
hardDrivesproperty is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures. \n - Each hard drive must specify the
capacityproperty. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"hardDrives\": [ \n { \n \"capacity\": 500 \n } \n ] \n} \n
\n \n sshKeys\nSSH keys to install on the server upon provisioning.- \n
- Optional \n
- Type - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]] \n
- Description - The
sshKeysproperty is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with theidproperty set to the value of an existing SSH key. \n - To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service. \n
- To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service. \n
{ \n \"sshKeys\": [ \n { \n \"id\": 123 \n } \n ] \n} \n
\n \n postInstallScriptUri\nSpecifies the uri location of the script to be downloaded and run after installation is complete.- \n
- Optional \n
- Type - string \n
\n \n
REST Example
\nBackwards Compatibility Until February 27th, 2019
\n\nIn order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period.- A \"doubled\" (eg. 200) speed value will be translated to a redundancy value of \"redundant\". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.
- A non-doubled (eg. 100) speed value without a redundancy value will be translated to a redundancy value of \"degraded\".
Backwards Compatibility Until February 27th, 2019
\n\nIn order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period.- A \"doubled\" (eg. 200) speed value will be translated to a redundancy value of \"redundant\". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.
- A non-doubled (eg. 100) speed value without a redundancy value will be translated to a redundancy value of \"degraded\".
provisionDate property. \nWhen provisionDate is not null, the server will be ready. Be sure to use the globalIdentifier \nas your initialization parameter. \n\n\nWarning: Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]]. \n\n\nInput - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]] \n- \n
hostname\nHostname for the server.- \n
- Required \n
- Type - string \n
\n \n domain\nDomain for the server.- \n
- Required \n
- Type - string \n
\n \n processorCoreAmount\nThe number of logical CPU cores to allocate.- \n
- Required \n
- Type - int \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n memoryCapacity\nThe amount of memory to allocate in gigabytes.- \n
- Required \n
- Type - int \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n hourlyBillingFlag\nSpecifies the billing type for the server.- \n
- Required \n
- Type - boolean \n
- When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis. \n
\n \n operatingSystemReferenceCode\nAn identifier for the operating system to provision the server with.- \n
- Required \n
- Type - string \n
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
\n \n datacenter.name\nSpecifies which datacenter the server is to be provisioned in.- \n
- Required \n
- Type - string \n
- The
datacenterproperty is a [[SoftLayer_Location (type)|location]] structure with thenamefield set. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"datacenter\": { \n \"name\": \"dal05\" \n } \n} \n
\n \n networkComponents.maxSpeed\nSpecifies the connection speed for the server's network components.- \n
- Optional \n
- Type - int \n
- Default - The highest available zero cost port speed will be used. \n
- Description - The
networkComponentsproperty is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. ThemaxSpeedproperty must be set to specify the network uplink speed, in megabits per second, of the server. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"networkComponents\": [ \n { \n \"maxSpeed\": 1000 \n } \n ] \n} \n
\n \n networkComponents.redundancyEnabledFlag\nSpecifies whether or not the server's network components should be in redundancy groups.- \n
- Optional \n
- Type - bool \n
- Default -
false \n - Description - The
networkComponentsproperty is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When theredundancyEnabledFlagproperty is true the server's network components will be in redundancy groups. \n
{ \n \"networkComponents\": [ \n { \n \"redundancyEnabledFlag\": false \n } \n ] \n} \n
\n \n privateNetworkOnlyFlag\nSpecifies whether or not the server only has access to the private network- \n
- Optional \n
- Type - boolean \n
- Default -
false \n - When true this flag specifies that a server is to only have access to the private network. \n
\n \n primaryNetworkComponent.networkVlan.id\nSpecifies the network vlan which is to be used for the frontend interface of the server.- \n
- Optional \n
- Type - int \n
- Description - The
primaryNetworkComponentproperty is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlanproperty populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theidproperty must be set to specify the frontend network vlan of the server. \n
{ \n \"primaryNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 1 \n } \n } \n} \n
\n \n primaryBackendNetworkComponent.networkVlan.id\nSpecifies the network vlan which is to be used for the backend interface of the server.- \n
- Optional \n
- Type - int \n
- Description - The
primaryBackendNetworkComponentproperty is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlanproperty populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theidproperty must be set to specify the backend network vlan of the server. \n
{ \n \"primaryBackendNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 2 \n } \n } \n} \n
\n \n fixedConfigurationPreset.keyName\n- \n
- Optional \n
- Type - string \n
- Description - The
fixedConfigurationPresetproperty is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. ThekeyNameproperty must be set to specify preset to use. \n - If a fixed configuration preset is used
processorCoreAmount,memoryCapacityandhardDrivesproperties must not be set. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"fixedConfigurationPreset\": { \n \"keyName\": \"SOME_KEY_NAME\" \n } \n} \n
\n \n userData.value\nArbitrary data to be made available to the server.- \n
- Optional \n
- Type - string \n
- Description - The
userDataproperty is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with thevalueproperty set to an arbitrary value. \n - This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot. \n
{ \n \"userData\": [ \n { \n \"value\": \"someValue\" \n } \n ] \n} \n
\n \n hardDrives\nHard drive settings for the server- \n
- Optional \n
- Type - SoftLayer_Hardware_Component \n
- Default - The largest available capacity for a zero cost primary disk will be used. \n
- Description - The
hardDrivesproperty is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures. \n - Each hard drive must specify the
capacityproperty. \n - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options. \n
{ \n \"hardDrives\": [ \n { \n \"capacity\": 500 \n } \n ] \n} \n
\n \n sshKeys\nSSH keys to install on the server upon provisioning.- \n
- Optional \n
- Type - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]] \n
- Description - The
sshKeysproperty is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with theidproperty set to the value of an existing SSH key. \n - To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service. \n
- To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service. \n
{ \n \"sshKeys\": [ \n { \n \"id\": 123 \n } \n ] \n} \n
\n \n postInstallScriptUri\nSpecifies the uri location of the script to be downloaded and run after installation is complete.- \n
- Optional \n
- Type - string \n
\n \n
REST Example
\nBackwards Compatibility Until February 27th, 2019
\n\nIn order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period.- A \"doubled\" (eg. 200) speed value will be translated to a redundancy value of \"redundant\". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.
- A non-doubled (eg. 100) speed value without a redundancy value will be translated to a redundancy value of \"degraded\".
Backwards Compatibility Until February 27th, 2019
\n\nIn order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period.- A \"doubled\" (eg. 200) speed value will be translated to a redundancy value of \"redundant\". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.
- A non-doubled (eg. 100) speed value without a redundancy value will be translated to a redundancy value of \"degraded\".
Responses
\n\nTrue The request to connect was successfully initiated. \n\nFalse The account and Service Endpoint networks are already connected. \n\n\n\nExceptions
\n\nSoftLayer_Exception_NotReady Thrown when the current network configuration will not support connection alteration. \n\n\n\n",
+ "summary": "Establishes a connection between the account and Service Endpoint networks.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network/connectPrivateEndpointService/"
+ },
+ "operationId": "SoftLayer_Network::connectPrivateEndpointService",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network/disconnectPrivateEndpointService": {
+ "get": {
+ "description": "Initiate the automated process to revoke mutual connectivity from the account network and IBM Cloud Service Endpoint network. Once initiated, the configuration process occurs asynchronously in the background. \n\n\n\nResponses
\n\nTrue The request to disconnect was successfully initiated. \n\nFalse The account and Service Endpoint networks are already disconnected. \n\n\n\nExceptions
\n\nSoftLayer_Exception_NotReady Thrown when the current network configuration will not support connection alteration. \n\n\n\n",
+ "summary": "Terminates the connection between the account and Service Endpoint networks.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network/disconnectPrivateEndpointService/"
+ },
+ "operationId": "SoftLayer_Network::disconnectPrivateEndpointService",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network/enableVrf": {
+ "get": {
+ "description": "Initiate the change of the private network to VRF, which will cause a brief private network outage. \n\n@SLDNDocumentation Method Permissions NETWORK_VLAN_SPANNING \n\nResponses
\n\nTrue The request to change the private network has been accepted and the change will begin immediately. \n\nFalse The request had no change because the private network is already in a VRF or in the process of converting to VRF. \n\nExceptions
\n\nSoftLayer_Exception_NotReady Thrown when the current private network cannot be converted to VRF without specialized assistance. ",
+ "summary": "Immediately starts the change of the private network to VRF.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network/enableVrf/"
+ },
+ "operationId": "SoftLayer_Network::enableVrf",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network/isConnectedToPrivateEndpointService": {
+ "get": {
+ "description": "Accessing select IBM Cloud services attached to the private back-end network is made possible by establishing a network relationship between an account's private network and the Service Endpoint network. \n\n\n\nResponses
\n\nTrue The account and Service Endpoint networks are currently connected. \n\nFalse The account and Service Endpoint networks are not connected; both networks are properly configured to connect. \n\n\n\nExceptions
\n\nSoftLayer_Exception_NotReady Thrown when the current network configuration will not support connection alteration. \n\n\n\n",
+ "summary": "Checks the current Service Endpoint network connection status.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network/isConnectedToPrivateEndpointService/"
+ },
+ "operationId": "SoftLayer_Network::isConnectedToPrivateEndpointService",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/createLiveLoadBalancer": {
+ "post": {
+ "description": "Create or add to an application delivery controller based load balancer service. The loadBalancer parameter must have its ''name'', ''type'', ''sourcePort'', and ''virtualIpAddress'' properties populated. Changes are reflected immediately in the application delivery controller. ",
+ "summary": "Add to or create load balancer service from a virtual IP address",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/createLiveLoadBalancer/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::createLiveLoadBalancer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::createLiveLoadBalancer::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::createLiveLoadBalancer::Parameters::Input",
+ "properties": {
+ "loadBalancer": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/deleteLiveLoadBalancer": {
+ "post": {
+ "description": "Remove a virtual IP address from an application delivery controller based load balancer. Only the ''name'' property in the loadBalancer parameter must be populated. Changes are reflected immediately in the application delivery controller. ",
+ "summary": "Remove a virtual IP address from a load balancer",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancer/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::deleteLiveLoadBalancer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::deleteLiveLoadBalancer::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::deleteLiveLoadBalancer::Parameters::Input",
+ "properties": {
+ "loadBalancer": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/deleteLiveLoadBalancerService": {
+ "post": {
+ "description": "Remove an entire load balancer service, including all virtual IP addresses, from and application delivery controller based load balancer. The ''name'' property the and ''name'' property within the ''vip'' property of the service parameter must be provided. Changes are reflected immediately in the application delivery controller. ",
+ "summary": "Remove load balancer service",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancerService/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::deleteLiveLoadBalancerService",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::deleteLiveLoadBalancerService::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::deleteLiveLoadBalancerService::Parameters::Input",
+ "properties": {
+ "service": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_Service"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/editObject": {
+ "post": {
+ "description": "Edit an applications delivery controller record. Currently only a controller's notes property is editable. ",
+ "summary": "Edit an application delivery controller record",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getBandwidthDataByDate": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthDataByDate/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getBandwidthDataByDate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::getBandwidthDataByDate::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::getBandwidthDataByDate::Parameters::Input",
+ "properties": {
+ "startDateTime": {
+ "type": "string"
+ },
+ "endDateTime": {
+ "type": "string"
+ },
+ "networkType": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getBandwidthImageByDate": {
+ "post": {
+ "description": "Use this method when needing a bandwidth image for a single application delivery controller. It will gather the correct input parameters for the generic graphing utility based on the date ranges ",
+ "summary": "Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for an application delivery controller. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthImageByDate/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getBandwidthImageByDate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::getBandwidthImageByDate::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::getBandwidthImageByDate::Parameters::Input",
+ "properties": {
+ "startDateTime": {
+ "type": "string"
+ },
+ "endDateTime": {
+ "type": "string"
+ },
+ "networkType": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getLiveLoadBalancerServiceGraphImage": {
+ "post": {
+ "description": "Get the graph image for an application delivery controller service based on the supplied graph type and metric. The available graph types are: 'connections' and 'status', and the available metrics are: 'day', 'week' and 'month'. \n\nThis method returns the raw binary image data. ",
+ "summary": "Get the connection or status graph image for an application delivery controller service.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLiveLoadBalancerServiceGraphImage/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getLiveLoadBalancerServiceGraphImage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::getLiveLoadBalancerServiceGraphImage::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::getLiveLoadBalancerServiceGraphImage::Parameters::Input",
+ "properties": {
+ "service": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_Service"
+ },
+ "graphType": {
+ "type": "string"
+ },
+ "metric": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Network_Application_Delivery_Controller object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Application_Delivery_Controller service. You can only retrieve application delivery controllers that are associated with your SoftLayer customer account. ",
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/restoreBaseConfiguration": {
+ "get": {
+ "description": "Restore an application delivery controller's base configuration state. The configuration will be set to what it was when initially provisioned. ",
+ "summary": "Restore an application delivery controller's base configuration state.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreBaseConfiguration/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::restoreBaseConfiguration",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/restoreConfiguration": {
+ "post": {
+ "description": "Restore an application delivery controller's configuration state. ",
+ "summary": "Restore an application delivery controller's configuration state.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreConfiguration/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::restoreConfiguration",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::restoreConfiguration::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::restoreConfiguration::Parameters::Input",
+ "properties": {
+ "configurationHistoryId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/saveCurrentConfiguration": {
+ "post": {
+ "description": "Save an application delivery controller's configuration state. The notes property for this method is optional. ",
+ "summary": "Save an application delivery controller's configuration state.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/saveCurrentConfiguration/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::saveCurrentConfiguration",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_Configuration_History"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::saveCurrentConfiguration::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::saveCurrentConfiguration::Parameters::Input",
+ "properties": {
+ "notes": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/updateLiveLoadBalancer": {
+ "post": {
+ "description": "Update the the virtual IP address interface within an application delivery controller based load balancer identified by the ''name'' property in the loadBalancer parameter. You only need to set the properties in the loadBalancer parameter that you wish to change. Any virtual IP properties omitted or left empty are ignored. Changes are reflected immediately in the application delivery controller. ",
+ "summary": "Edit a virtual IP address within a load balancer",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateLiveLoadBalancer/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::updateLiveLoadBalancer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::updateLiveLoadBalancer::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller::updateLiveLoadBalancer::Parameters::Input",
+ "properties": {
+ "loadBalancer": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/updateNetScalerLicense": {
+ "get": {
+ "description": "Update the NetScaler VPX License. \n\nThis service will create a transaction to update a NetScaler VPX License. After the license is updated the load balancer will reboot in order to apply the newly issued license \n\nThe load balancer will be unavailable during the reboot. ",
+ "summary": "Update the NetScaler VPX License.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateNetScalerLicense/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::updateNetScalerLicense",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getAccount": {
+ "get": {
+ "description": "The SoftLayer customer account that owns an application delivery controller record.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getAverageDailyPublicBandwidthUsage": {
+ "get": {
+ "description": "The average daily public bandwidth usage for the current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAverageDailyPublicBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getAverageDailyPublicBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getBillingItem": {
+ "get": {
+ "description": "The billing item for a Application Delivery Controller.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item_Network_Application_Delivery_Controller"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getConfigurationHistory": {
+ "get": {
+ "description": "Previous configurations for an Application Delivery Controller.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getConfigurationHistory/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getConfigurationHistory",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_Configuration_History"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getDatacenter": {
+ "get": {
+ "description": "The datacenter that the application delivery controller resides in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDatacenter/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getDatacenter",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Location"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getDescription": {
+ "get": {
+ "description": "A brief description of an application delivery controller record.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDescription/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getDescription",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getInboundPublicBandwidthUsage": {
+ "get": {
+ "description": "The total public inbound bandwidth for the current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getInboundPublicBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getInboundPublicBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getLicenseExpirationDate": {
+ "get": {
+ "description": "The date in which the license for this application delivery controller will expire.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLicenseExpirationDate/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getLicenseExpirationDate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getLoadBalancers": {
+ "get": {
+ "description": "The virtual IP address records that belong to an application delivery controller based load balancer.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLoadBalancers/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getLoadBalancers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getManagedResourceFlag": {
+ "get": {
+ "description": "A flag indicating that this Application Delivery Controller is a managed resource.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagedResourceFlag/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getManagedResourceFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getManagementIpAddress": {
+ "get": {
+ "description": "An application delivery controller's management ip address.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagementIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getManagementIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getNetworkVlan": {
+ "get": {
+ "description": "The network VLAN that an application delivery controller resides on.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlan/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getNetworkVlan",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getNetworkVlans": {
+ "get": {
+ "description": "The network VLANs that an application delivery controller resides on.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlans/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getNetworkVlans",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getOutboundPublicBandwidthUsage": {
+ "get": {
+ "description": "The total public outbound bandwidth for the current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getOutboundPublicBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getOutboundPublicBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getPassword": {
+ "get": {
+ "description": "The password used to connect to an application delivery controller's management interface when it is operating in advanced view mode.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPassword/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getPassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Software_Component_Password"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getPrimaryIpAddress": {
+ "get": {
+ "description": "An application delivery controller's primary public IP address.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPrimaryIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getPrimaryIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getProjectedPublicBandwidthUsage": {
+ "get": {
+ "description": "The projected public outbound bandwidth for the current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getProjectedPublicBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getProjectedPublicBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getSubnets": {
+ "get": {
+ "description": "A network application controller's subnets. A subnet is a group of IP addresses",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getSubnets/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getSubnets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getTagReferences": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getTagReferences/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getTagReferences",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Tag_Reference"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getType": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getType/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getVirtualIpAddresses": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller/getVirtualIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller::getVirtualIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_ControllerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/{SoftLayer_Network_Application_Delivery_Controller_Configuration_HistoryID}/deleteObject": {
+ "get": {
+ "description": "deleteObject permanently removes a configuration history record ",
+ "summary": "Remove a configuration history record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_Configuration_History::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_Configuration_HistoryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_Configuration_History object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/{SoftLayer_Network_Application_Delivery_Controller_Configuration_HistoryID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_Configuration_History record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_Configuration_History::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_Configuration_History"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_Configuration_HistoryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_Configuration_History object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/{SoftLayer_Network_Application_Delivery_Controller_Configuration_HistoryID}/getController": {
+ "get": {
+ "description": "The application delivery controller that a configuration history record belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getController/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_Configuration_History::getController",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_Configuration_HistoryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_Configuration_History object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_AttributeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_AttributeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_AttributeID}/getHealthCheck": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getHealthCheck/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute::getHealthCheck",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_AttributeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_AttributeID}/getType": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getType/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute::getType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_AttributeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_TypeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_TypeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID}/getAttributes": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getAttributes/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check::getAttributes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID}/getServices": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getServices/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check::getServices",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID}/getType": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getType/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check::getType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_TypeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_TypeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_MethodID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_MethodID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_TypeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_TypeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/deleteObject": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getGraphImage": {
+ "post": {
+ "description": "Get the graph image for a load balancer 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'. \n\nThis method returns the raw binary image data. ",
+ "summary": "Get the connection or status graph image for a load balancer service.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGraphImage/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::getGraphImage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::getGraphImage::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::getGraphImage::Parameters::Input",
+ "properties": {
+ "graphType": {
+ "type": "string"
+ },
+ "metric": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/toggleStatus": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/toggleStatus/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::toggleStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getGroupReferences": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroupReferences/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::getGroupReferences",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getGroups": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroups/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::getGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getHealthCheck": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthCheck/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::getHealthCheck",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getHealthChecks": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthChecks/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::getHealthChecks",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getIpAddress": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::getIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getServiceGroup": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getServiceGroup/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service::getServiceGroup",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getGraphImage": {
+ "post": {
+ "description": "Get the graph image for a load balancer service group based on the supplied graph type and metric. The only available graph type currently is: 'connections', and the available metrics are: 'day', 'week' and 'month'. \n\nThis method returns the raw binary image data. ",
+ "summary": "Get the connection or status graph image for a load balancer service group.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getGraphImage/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::getGraphImage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::getGraphImage::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::getGraphImage::Parameters::Input",
+ "properties": {
+ "graphType": {
+ "type": "string"
+ },
+ "metric": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/kickAllConnections": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/kickAllConnections/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::kickAllConnections",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getRoutingMethod": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingMethod/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::getRoutingMethod",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getRoutingType": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingType/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::getRoutingType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getServiceReferences": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServiceReferences/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::getServiceReferences",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getServices": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServices/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::getServices",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getVirtualServer": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServer/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::getVirtualServer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getVirtualServers": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServers/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group::getVirtualServers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/editObject": {
+ "post": {
+ "description": "Like any other API object, the load balancers can have their exposed properties edited by passing in a modified version of the object. The load balancer object also can modify its services in this way. Simply request the load balancer object you wish to edit, then modify the objects in the services array and pass the modified object to this function. WARNING: Services cannot be deleted in this manner, you must call deleteObject() on the service to physically remove them from the load balancer. ",
+ "summary": "Edit the object by passing in a modified instance of the object",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getAvailableSecureTransportCiphers": {
+ "get": {
+ "description": "Yields a list of the SSL/TLS encryption ciphers that are currently supported on this virtual IP address instance. ",
+ "summary": "Lists the SSL encryption ciphers available to this virtual IP address",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportCiphers/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getAvailableSecureTransportCiphers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Security_SecureTransportCipher"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getAvailableSecureTransportProtocols": {
+ "get": {
+ "description": "Yields a list of the secure communication protocols that are currently supported on this virtual IP address instance. The list of supported ciphers for each protocol is culled to match availability. ",
+ "summary": "Lists the secure communication protocols available to this virtual IP address ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportProtocols/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getAvailableSecureTransportProtocols",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Security_SecureTransportProtocol"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/startSsl": {
+ "get": {
+ "description": "Start SSL acceleration on all SSL virtual services (those with a type of HTTPS). This action should be taken only after configuring an SSL certificate for the virtual IP. ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/startSsl/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::startSsl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/stopSsl": {
+ "get": {
+ "description": "Stop SSL acceleration on all SSL virtual services (those with a type of HTTPS). ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/stopSsl/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::stopSsl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/upgradeConnectionLimit": {
+ "get": {
+ "description": "Upgrades the connection limit on the Virtual IP to Address to the next, higher connection limit of the same product. ",
+ "summary": "Upgrades the connection limit on the Virtual IP Address and changes the billing item on your account to reflect the change.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::upgradeConnectionLimit",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getAccount": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getApplicationDeliveryController": {
+ "get": {
+ "description": "A virtual IP address's associated application delivery controller.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryController/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getApplicationDeliveryController",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getApplicationDeliveryControllers": {
+ "get": {
+ "description": "A virtual IP address's associated application delivery controllers.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryControllers/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getApplicationDeliveryControllers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getBillingItem": {
+ "get": {
+ "description": "The current billing item for the load balancer virtual IP. This is only valid when dedicatedFlag is false. This is an independent virtual IP, and if canceled, will only affect the associated virtual IP.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getDedicatedBillingItem": {
+ "get": {
+ "description": "The current billing item for the load balancing device housing the virtual IP. This billing item represents a device which could contain other virtual IPs. Caution should be taken when canceling. This is only valid when dedicatedFlag is true.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getDedicatedBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getDedicatedBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item_Network_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getHighAvailabilityFlag": {
+ "get": {
+ "description": "Denotes whether the virtual IP is configured within a high availability cluster.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getHighAvailabilityFlag/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getHighAvailabilityFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getIpAddress": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getLoadBalancerHardware": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getLoadBalancerHardware/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getLoadBalancerHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getManagedResourceFlag": {
+ "get": {
+ "description": "A flag indicating that the load balancer is a managed resource.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getManagedResourceFlag/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getManagedResourceFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getSecureTransportCiphers": {
+ "get": {
+ "description": "The list of security ciphers enabled for this virtual IP address",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportCiphers/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getSecureTransportCiphers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getSecureTransportProtocols": {
+ "get": {
+ "description": "The list of secure transport protocols enabled for this virtual IP address",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportProtocols/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getSecureTransportProtocols",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getSecurityCertificate": {
+ "get": {
+ "description": "The SSL certificate currently associated with the VIP.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificate/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getSecurityCertificate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Security_Certificate"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getSecurityCertificateEntry": {
+ "get": {
+ "description": "The SSL certificate currently associated with the VIP. Provides chosen certificate visibility to unprivileged users.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificateEntry/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getSecurityCertificateEntry",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Security_Certificate_Entry"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getVirtualServers": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getVirtualServers/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getVirtualServers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/deleteObject": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/startSsl": {
+ "get": {
+ "description": "Start SSL acceleration on all SSL virtual services (those with a type of HTTPS). This action should be taken only after configuring an SSL certificate for the virtual IP. ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/startSsl/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer::startSsl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/stopSsl": {
+ "get": {
+ "description": "Stop SSL acceleration on all SSL virtual services (those with a type of HTTPS). ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/stopSsl/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer::stopSsl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/getRoutingMethod": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getRoutingMethod/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer::getRoutingMethod",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/getServiceGroups": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getServiceGroups/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer::getServiceGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/getVirtualIpAddress": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getVirtualIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer::getVirtualIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/createObject": {
+ "post": {
+ "description": "Create a allotment for servers to pool bandwidth and avoid overages in billing if they use more than there allocated bandwidth. ",
+ "summary": "create a new allotment by passing in a allotment object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/editObject": {
+ "post": {
+ "description": "Edit a bandwidth allotment's local properties. Currently you may only change an allotment's name. Use the [[SoftLayer_Network_Bandwidth_Version1_Allotment::reassignServers|reassignServers()]] and [[SoftLayer_Network_Bandwidth_Version1_Allotment::unassignServers|unassignServers()]] methods to move servers in and out of your allotments. ",
+ "summary": "Edit a bandwidth allotment",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBandwidthForDateRange": {
+ "post": {
+ "description": "Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems. ",
+ "summary": "Retrieve bandwidth data from a tracking object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthForDateRange/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthForDateRange",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthForDateRange::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthForDateRange::Parameters::Input",
+ "properties": {
+ "startDate": {
+ "type": "string"
+ },
+ "endDate": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBandwidthImage": {
+ "post": {
+ "description": "This method recurses through all servers on a Bandwidth Pool for a given snapshot range, gathers the necessary parameters, and then calls the bandwidth graphing server. The return result is a container that includes the min and max dates for all servers to be used in the query, as well as an image in PNG format. This method uses the new and improved drawing routines which should return in a reasonable time frame now that the new backend data warehouse is used. ",
+ "summary": "generate a graph image of all the bandwidth usage for an entire allotment of servers.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthImage/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthImage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthImage::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthImage::Parameters::Input",
+ "properties": {
+ "networkType": {
+ "type": "string"
+ },
+ "snapshotRange": {
+ "type": "string"
+ },
+ "draw": {
+ "type": "boolean"
+ },
+ "dateSpecified": {
+ "type": "string"
+ },
+ "dateSpecifiedEnd": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Network_Bandwidth_Version1_Allotment object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve an allotment associated with the account that your portal user is assigned to. ",
+ "summary": "Retrieve a SoftLayer_Network_Bandwidth_Version1_Allotment record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getVdrMemberRecurringFee": {
+ "get": {
+ "description": "Gets the monthly recurring fee of a pooled server. ",
+ "summary": "Gets the monthly recurring fee of a pooled server.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVdrMemberRecurringFee/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getVdrMemberRecurringFee",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/reassignServers": {
+ "post": {
+ "description": "This method will reassign a collection of SoftLayer hardware to a bandwidth allotment Bandwidth Pool. ",
+ "summary": "reassign a collection of servers to a different allotment.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/reassignServers/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::reassignServers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::reassignServers::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::reassignServers::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ },
+ "newAllotmentId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/requestVdrCancellation": {
+ "get": {
+ "description": "This will remove a bandwidth pooling from a customer's allotments by cancelling the billing item. All servers in that allotment will get moved to the account's vpr. ",
+ "summary": "cancel a bandwidth pooling and assign contents, if any, to bandwidth pool.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrCancellation/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::requestVdrCancellation",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/requestVdrContentUpdates": {
+ "post": {
+ "description": "This will move servers into a bandwidth pool, removing them from their previous bandwidth pool and optionally remove the bandwidth pool on completion. ",
+ "summary": "Move servers into our out of a bandwidth pool.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrContentUpdates/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::requestVdrContentUpdates",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::requestVdrContentUpdates::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::requestVdrContentUpdates::Parameters::Input",
+ "properties": {
+ "hardwareToAdd": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ },
+ "hardwareToRemove": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ },
+ "cloudsToAdd": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ },
+ "cloudsToRemove": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ },
+ "optionalAllotmentId": {
+ "type": "number"
+ },
+ "adcToAdd": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller"
+ }
+ },
+ "adcToRemove": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/setVdrContent": {
+ "post": {
+ "description": "This will update the bandwidth pool to the servers provided. Servers currently in the bandwidth pool not provided on update will be removed. Servers provided on update not currently in the bandwidth pool will be added. If all servers are removed, this removes the bandwidth pool on completion. ",
+ "summary": "Update bandwidth pool.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/setVdrContent/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::setVdrContent",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::setVdrContent::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::setVdrContent::Parameters::Input",
+ "properties": {
+ "hardware": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ },
+ "bareMetalServers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ },
+ "virtualServerInstance": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ },
+ "adc": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller"
+ }
+ },
+ "optionalAllotmentId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/unassignServers": {
+ "post": {
+ "description": "This method will reassign a collection of SoftLayer hardware to the virtual private rack ",
+ "summary": "unassign a collection of servers from an allotment and insert them into the accounts VPR.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/unassignServers/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::unassignServers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::unassignServers::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::unassignServers::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/voidPendingServerMove": {
+ "post": {
+ "description": "This method will void a pending server removal from this bandwidth pooling. Pass in the id of the hardware object or virtual guest you wish to update. Assuming that object is currently pending removal from the bandwidth pool at the start of the next billing cycle, the bandwidth pool member status will be restored and the pending cancellation removed. ",
+ "summary": "Void a pending server removal from this bandwidth pooling.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingServerMove/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::voidPendingServerMove",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::voidPendingServerMove::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Bandwidth_Version1_Allotment::voidPendingServerMove::Parameters::Input",
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/voidPendingVdrCancellation": {
+ "get": {
+ "description": "This method will void a pending cancellation on a bandwidth pool. Note however any servers that belonged to the rack will have to be restored individually using the method voidPendingServerMove($id, $type). ",
+ "summary": "Void a pending cancellation on a bandwidth pool.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingVdrCancellation/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::voidPendingVdrCancellation",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getAccount": {
+ "get": {
+ "description": "The account associated with this virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getActiveDetails": {
+ "get": {
+ "description": "The bandwidth allotment detail records associated with this virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getActiveDetails/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getActiveDetails",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getApplicationDeliveryControllers": {
+ "get": {
+ "description": "The Application Delivery Controller contained within a virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getApplicationDeliveryControllers/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getApplicationDeliveryControllers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getAverageDailyPublicBandwidthUsage": {
+ "get": {
+ "description": "The average daily public bandwidth usage for the current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAverageDailyPublicBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getAverageDailyPublicBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBandwidthAllotmentType": {
+ "get": {
+ "description": "The bandwidth allotment type of this virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthAllotmentType/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthAllotmentType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBareMetalInstances": {
+ "get": {
+ "description": "The bare metal server instances contained within a virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBareMetalInstances/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBareMetalInstances",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBillingCycleBandwidthUsage": {
+ "get": {
+ "description": "A virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCycleBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBillingCycleBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBillingCyclePrivateBandwidthUsage": {
+ "get": {
+ "description": "A virtual rack's raw private network bandwidth usage data for an account's current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePrivateBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBillingCyclePrivateBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBillingCyclePublicBandwidthUsage": {
+ "get": {
+ "description": "A virtual rack's raw public network bandwidth usage data for an account's current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBillingCyclePublicBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBillingCyclePublicUsageTotal": {
+ "get": {
+ "description": "The total public bandwidth used in this virtual rack for an account's current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicUsageTotal/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBillingCyclePublicUsageTotal",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBillingItem": {
+ "get": {
+ "description": "A virtual rack's billing item.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getCurrentBandwidthSummary": {
+ "get": {
+ "description": "An object that provides commonly used bandwidth summary components for the current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCurrentBandwidthSummary/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getCurrentBandwidthSummary",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getDetails": {
+ "get": {
+ "description": "The bandwidth allotment detail records associated with this virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getDetails/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getDetails",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getHardware": {
+ "get": {
+ "description": "The hardware contained within a virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getHardware/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getInboundPublicBandwidthUsage": {
+ "get": {
+ "description": "The total public inbound bandwidth used in this virtual rack for an account's current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getInboundPublicBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getInboundPublicBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getLocationGroup": {
+ "get": {
+ "description": "The location group associated with this virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getLocationGroup/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getLocationGroup",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Location_Group"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getManagedBareMetalInstances": {
+ "get": {
+ "description": "The managed bare metal server instances contained within a virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedBareMetalInstances/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getManagedBareMetalInstances",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getManagedHardware": {
+ "get": {
+ "description": "The managed hardware contained within a virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedHardware/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getManagedHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getManagedVirtualGuests": {
+ "get": {
+ "description": "The managed Virtual Server contained within a virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedVirtualGuests/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getManagedVirtualGuests",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getMetricTrackingObject": {
+ "get": {
+ "description": "A virtual rack's metric tracking object. This object records all periodic polled data available to this rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObject/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getMetricTrackingObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getMetricTrackingObjectId": {
+ "get": {
+ "description": "The metric tracking object id for this allotment.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObjectId/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getMetricTrackingObjectId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getOutboundPublicBandwidthUsage": {
+ "get": {
+ "description": "The total public outbound bandwidth used in this virtual rack for an account's current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOutboundPublicBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getOutboundPublicBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getOverBandwidthAllocationFlag": {
+ "get": {
+ "description": "Whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOverBandwidthAllocationFlag/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getOverBandwidthAllocationFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getPrivateNetworkOnlyHardware": {
+ "get": {
+ "description": "The private network only hardware contained within a virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getPrivateNetworkOnlyHardware/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getPrivateNetworkOnlyHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getProjectedOverBandwidthAllocationFlag": {
+ "get": {
+ "description": "Whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedOverBandwidthAllocationFlag/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getProjectedOverBandwidthAllocationFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getProjectedPublicBandwidthUsage": {
+ "get": {
+ "description": "The projected public outbound bandwidth for this virtual server for the current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedPublicBandwidthUsage/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getProjectedPublicBandwidthUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getServiceProvider": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getServiceProvider/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getServiceProvider",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Service_Provider"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getTotalBandwidthAllocated": {
+ "get": {
+ "description": "The combined allocated bandwidth for all servers in a virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getTotalBandwidthAllocated/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getTotalBandwidthAllocated",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getVirtualGuests": {
+ "get": {
+ "description": "The Virtual Server contained within a virtual rack.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVirtualGuests/"
+ },
+ "operationId": "SoftLayer_Network_Bandwidth_Version1_Allotment::getVirtualGuests",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Bandwidth_Version1_AllotmentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Bandwidth_Version1_Allotment object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Account/{SoftLayer_Network_CdnMarketplace_AccountID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Account record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Account/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Account::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_AccountID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Account object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists": {
+ "post": {
+ "description": null,
+ "summary": "Wrapper for UI to verify whether or not an account exists for user under specified vendor. Returns true if account exists, else false. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Account::verifyCdnAccountExists",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Account::verifyCdnAccountExists::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Account::verifyCdnAccountExists::Parameters::Input",
+ "properties": {
+ "vendorName": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Account/{SoftLayer_Network_CdnMarketplace_AccountID}/getAccount": {
+ "get": {
+ "description": "SoftLayer account to which the CDN account belongs.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Account/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Account::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_AccountID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Account object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Account/{SoftLayer_Network_CdnMarketplace_AccountID}/getBillingItem": {
+ "get": {
+ "description": "An associated parent billing item which is active.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Account/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Account::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_AccountID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Account object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::createGeoblocking",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::createGeoblocking::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::createGeoblocking::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::deleteGeoblocking",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::deleteGeoblocking::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::deleteGeoblocking::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::getGeoblocking",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::getGeoblocking::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::getGeoblocking::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::getGeoblockingAllowedTypesAndRegions",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::getGeoblockingAllowedTypesAndRegions::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::getGeoblockingAllowedTypesAndRegions::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/{SoftLayer_Network_CdnMarketplace_Configuration_Behavior_GeoblockingID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_GeoblockingID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::updateGeoblocking",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::updateGeoblocking::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::updateGeoblocking::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::createHotlinkProtection",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::createHotlinkProtection::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::createHotlinkProtection::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::deleteHotlinkProtection",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::deleteHotlinkProtection::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::deleteHotlinkProtection::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::getHotlinkProtection",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::getHotlinkProtection::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::getHotlinkProtection::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/{SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtectionID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtectionID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::updateHotlinkProtection",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::updateHotlinkProtection::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::updateHotlinkProtection::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will create modify response header for an existing CDN mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::createModifyResponseHeader",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::createModifyResponseHeader::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::createModifyResponseHeader::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will delete modify response header for an existing mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::deleteModifyResponseHeader",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::deleteModifyResponseHeader::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::deleteModifyResponseHeader::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "modResHeaderUniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/{SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeaderID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeaderID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will list modify response headers for an existing mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::listModifyResponseHeader",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::listModifyResponseHeader::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::listModifyResponseHeader::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will update modify response header for an existing mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::updateModifyResponseHeader",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::updateModifyResponseHeader::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::updateModifyResponseHeader::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will create Token authentication Path for an existing CDN mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::createTokenAuthPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::createTokenAuthPath::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::createTokenAuthPath::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will delete token authentication Path for an existing mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::deleteTokenAuthPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::deleteTokenAuthPath::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::deleteTokenAuthPath::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/{SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuthID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuthID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will list token authentication paths for an existing mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::listTokenAuthPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::listTokenAuthPath::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::listTokenAuthPath::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will update Token authentication Path for an existing mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::updateTokenAuthPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::updateTokenAuthPath::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::updateTokenAuthPath::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge": {
+ "post": {
+ "description": null,
+ "summary": "This method creates a purge record in the purge table, and also initiates the create purge call. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::createPurge",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::createPurge::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::createPurge::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/{SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping": {
+ "post": {
+ "description": null,
+ "summary": "This method returns the purge history for a given domain and CDN account. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::getPurgeHistoryPerMapping",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::getPurgeHistoryPerMapping::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::getPurgeHistoryPerMapping::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "saved": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus": {
+ "post": {
+ "description": null,
+ "summary": "This method gets the status of a given purge path. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::getPurgeStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::getPurgeStatus::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::getPurgeStatus::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath": {
+ "post": {
+ "description": null,
+ "summary": "Creates a new saved purge if a purge path is saved. Deletes a saved purge record if the path is unsaved. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::saveOrUnsavePurgePath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::saveOrUnsavePurgePath::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::saveOrUnsavePurgePath::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "saveOrUnsave": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup": {
+ "post": {
+ "description": null,
+ "summary": "This method creates a purge group record in the table, and also initiates the purge action based on the input option value. The unsaved groups will be deleted after 15 days if no purge actions executed. The possible input option value can be: 1: (Default) Only purge the paths in the group, don't save the group as favorite. 2: Only save the group as favorite, don't purge the paths. 3: Save the group as favorite and also purge the paths in the group. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::createPurgeGroup",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::createPurgeGroup::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::createPurgeGroup::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "paths": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "option": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/{SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroupID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId": {
+ "post": {
+ "description": null,
+ "summary": "This method returns the purge group for a given domain and group ID. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::getPurgeGroupByGroupId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::getPurgeGroupByGroupId::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::getPurgeGroupByGroupId::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "groupUniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota": {
+ "get": {
+ "description": null,
+ "summary": "This method gets a purge group quota. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::getPurgeGroupQuota",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup": {
+ "post": {
+ "description": null,
+ "summary": "This method returns the list of favorite purge groups. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::listFavoriteGroup",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::listFavoriteGroup::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::listFavoriteGroup::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup": {
+ "post": {
+ "description": null,
+ "summary": "This method returns the list of unsaved purge groups. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::listUnfavoriteGroup",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::listUnfavoriteGroup::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::listUnfavoriteGroup::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds": {
+ "post": {
+ "description": null,
+ "summary": "This method purges the content from purge groups. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::purgeByGroupIds",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::purgeByGroupIds::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::purgeByGroupIds::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "groupUniqueIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite": {
+ "post": {
+ "description": null,
+ "summary": "This method removes a purge group from favorite. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::removePurgeGroupFromFavorite",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::removePurgeGroupFromFavorite::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::removePurgeGroupFromFavorite::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "groupUniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite": {
+ "post": {
+ "description": null,
+ "summary": "This method saves a purge group as favorite. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::savePurgeGroupAsFavorite",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::savePurgeGroupAsFavorite::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::savePurgeGroupAsFavorite::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "groupUniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/{SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistoryID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistoryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory": {
+ "post": {
+ "description": null,
+ "summary": "This method returns the list of purge group histories ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory::listPurgeGroupHistory",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory::listPurgeGroupHistory::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory::listPurgeGroupHistory::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive": {
+ "post": {
+ "description": null,
+ "summary": "Creates a Time To Live object and inserts it into the database ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::createTimeToLive",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::createTimeToLive::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::createTimeToLive::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "pathName": {
+ "type": "string"
+ },
+ "ttl": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::deleteTimeToLive",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::deleteTimeToLive::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::deleteTimeToLive::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "pathName": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/{SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLiveID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLiveID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::listTimeToLive",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::listTimeToLive::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::listTimeToLive::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive": {
+ "post": {
+ "description": null,
+ "summary": "Updates an existing Time To Live object. If the old and new inputs are equal, exits early. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::updateTimeToLive",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::updateTimeToLive::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::updateTimeToLive::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "oldPath": {
+ "type": "string"
+ },
+ "newPath": {
+ "type": "string"
+ },
+ "oldTtl": {
+ "type": "string"
+ },
+ "newTtl": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will create a new CDN domain mapping for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::createDomainMapping",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::createDomainMapping::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::createDomainMapping::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will delete CDN domain mapping for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::deleteDomainMapping",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::deleteDomainMapping::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::deleteDomainMapping::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/{SoftLayer_Network_CdnMarketplace_Configuration_MappingID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Mapping"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_Configuration_MappingID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Configuration_Mapping object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will return the domain mapping based on the uniqueId. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::listDomainMappingByUniqueId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::listDomainMappingByUniqueId::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::listDomainMappingByUniqueId::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings": {
+ "get": {
+ "description": null,
+ "summary": "SOAP API will return all domains for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::listDomainMappings",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest": {
+ "post": {
+ "description": null,
+ "summary": "For specific mappings in HTTPS-related error states, this SOAP API will determine whether it needs to re-attempt an enable or disable HTTPS. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::retryHttpsActionRequest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::retryHttpsActionRequest::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::retryHttpsActionRequest::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will start CDN domain mapping for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::startDomainMapping",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::startDomainMapping::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::startDomainMapping::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will stop CDN mapping for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::stopDomainMapping",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::stopDomainMapping::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::stopDomainMapping::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will update the Domain Mapping identified by the Unique Id. Following fields are allowed to be changed: originHost, HttpPort/HttpsPort, RespectHeaders, ServeStale \n\nAdditionally, bucketName and fileExtension if OriginType is Object Store ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::updateDomainMapping",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::updateDomainMapping::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::updateDomainMapping::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname": {
+ "post": {
+ "description": "Verifies the CNAME is Unique in the domain. The method will return true if CNAME is unique else returns false ",
+ "summary": "This method will verify the CNAME given is unique. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::verifyCname",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::verifyCname::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::verifyCname::Parameters::Input",
+ "properties": {
+ "cname": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping": {
+ "post": {
+ "description": "Verifies the status of the domain mapping by calling the rest api; will update the status, cname, and vendorCName if necessary and will return the updated values. ",
+ "summary": "This method will verify the status of a domain mapping ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::verifyDomainMapping",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::verifyDomainMapping::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping::verifyDomainMapping::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will create Origin Path for an existing CDN mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::createOriginPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::createOriginPath::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::createOriginPath::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will delete Origin Path for an existing mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::deleteOriginPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::deleteOriginPath::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::deleteOriginPath::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/{SoftLayer_Network_CdnMarketplace_Configuration_Mapping_PathID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_PathID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will list origin path for an existing mapping and for a particular customer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::listOriginPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::listOriginPath::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::listOriginPath::Parameters::Input",
+ "properties": {
+ "uniqueId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath": {
+ "post": {
+ "description": null,
+ "summary": "SOAP API will update Origin Path for an existing mapping and for a particular customer. \n\nWhen passing the $input object as a parameter, it will expect the following properties to be set: $oldPath $uniqueId $originType, $path, $origin, $httpPort, $httpsPort, and if the path's origin type is object storage, the $bucketName and the $fileExtension. \n\nOut of the properties listed above only the following path properties are allowed to be changed: $path, $origin, $httpPort, $httpsPort These properties may not be changed: $originType ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::updateOriginPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::updateOriginPath::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::updateOriginPath::Parameters::Input",
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics": {
+ "post": {
+ "description": null,
+ "summary": "Get the static & dynamic bandwidth and mapping hits of predetermined statistics for direct display (no graph) for a customer's account over a given period of time. Frequency can be 'day', 'aggregate'. If the value 'day' is specified for Frequency, return data will be ordered based on startDate to endDate, and if the value 'aggregate' is specified for Frequency, aggregated data from startDate to endDate will be returned. There is a delay within 3 days(including today) for fetching the metrics data. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Metrics::getCustomerInvoicingMetrics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getCustomerInvoicingMetrics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getCustomerInvoicingMetrics::Parameters::Input",
+ "properties": {
+ "vendorName": {
+ "type": "string"
+ },
+ "startDate": {
+ "type": "number"
+ },
+ "endDate": {
+ "type": "number"
+ },
+ "frequency": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics": {
+ "post": {
+ "description": null,
+ "summary": "Get the realtime metrics data for the current account. Takes the startTime and endTime and returns the total metrics data and line graph metrics data divided by the timeInterval. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Metrics::getCustomerRealTimeMetrics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getCustomerRealTimeMetrics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getCustomerRealTimeMetrics::Parameters::Input",
+ "properties": {
+ "vendorName": {
+ "type": "string"
+ },
+ "startTime": {
+ "type": "number"
+ },
+ "endTime": {
+ "type": "number"
+ },
+ "timeInterval": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics": {
+ "post": {
+ "description": null,
+ "summary": "Get the total number of predetermined statistics for direct display (no graph) for a customer's account over a given period of time ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Metrics::getCustomerUsageMetrics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getCustomerUsageMetrics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getCustomerUsageMetrics::Parameters::Input",
+ "properties": {
+ "vendorName": {
+ "type": "string"
+ },
+ "startDate": {
+ "type": "number"
+ },
+ "endDate": {
+ "type": "number"
+ },
+ "frequency": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics": {
+ "post": {
+ "description": null,
+ "summary": "Get the total number of predetermined statistics for direct display (no graph) for a customer's account over a given period of time ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingBandwidthByRegionMetrics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingBandwidthByRegionMetrics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingBandwidthByRegionMetrics::Parameters::Input",
+ "properties": {
+ "mappingUniqueId": {
+ "type": "string"
+ },
+ "startDate": {
+ "type": "number"
+ },
+ "endDate": {
+ "type": "number"
+ },
+ "frequency": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics": {
+ "post": {
+ "description": null,
+ "summary": "Get the amount of edge hits for an individual mapping. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingBandwidthMetrics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingBandwidthMetrics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingBandwidthMetrics::Parameters::Input",
+ "properties": {
+ "mappingUniqueId": {
+ "type": "string"
+ },
+ "startDate": {
+ "type": "number"
+ },
+ "endDate": {
+ "type": "number"
+ },
+ "frequency": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics": {
+ "post": {
+ "description": null,
+ "summary": "Get the total number of hits at a certain frequency over a given range of time. Frequency can be day, week, and month where each interval is one plot point for a graph. Return Data must be ordered based on startDate, endDate and frequency ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingHitsByTypeMetrics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingHitsByTypeMetrics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingHitsByTypeMetrics::Parameters::Input",
+ "properties": {
+ "mappingUniqueId": {
+ "type": "string"
+ },
+ "startDate": {
+ "type": "number"
+ },
+ "endDate": {
+ "type": "number"
+ },
+ "frequency": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics": {
+ "post": {
+ "description": null,
+ "summary": "Get the total number of hits at a certain frequency over a given range of time per domain mapping. Frequency can be day, week, and month where each interval is one plot point for a graph. Return Data will be ordered based on startDate, endDate and frequency. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingHitsMetrics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingHitsMetrics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingHitsMetrics::Parameters::Input",
+ "properties": {
+ "mappingUniqueId": {
+ "type": "string"
+ },
+ "startDate": {
+ "type": "number"
+ },
+ "endDate": {
+ "type": "number"
+ },
+ "frequency": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics": {
+ "post": {
+ "description": null,
+ "summary": "Get the integrated metrics data for the given mapping. You can get the the hits, bandwidth, hits by type and bandwidth by region. It will return both the total data and the detail data. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingIntegratedMetrics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingIntegratedMetrics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingIntegratedMetrics::Parameters::Input",
+ "properties": {
+ "mappingUniqueId": {
+ "type": "string"
+ },
+ "startTime": {
+ "type": "number"
+ },
+ "endTime": {
+ "type": "number"
+ },
+ "frequency": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics": {
+ "post": {
+ "description": null,
+ "summary": "Get the real time metrics data for the given mapping ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingRealTimeMetrics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingRealTimeMetrics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingRealTimeMetrics::Parameters::Input",
+ "properties": {
+ "mappingUniqueId": {
+ "type": "string"
+ },
+ "startTime": {
+ "type": "number"
+ },
+ "endTime": {
+ "type": "number"
+ },
+ "timeInterval": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics": {
+ "post": {
+ "description": null,
+ "summary": "Get the total number of predetermined statistics for direct display for the given mapping ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingUsageMetrics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingUsageMetrics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_CdnMarketplace_Metrics::getMappingUsageMetrics::Parameters::Input",
+ "properties": {
+ "mappingUniqueId": {
+ "type": "string"
+ },
+ "startDate": {
+ "type": "number"
+ },
+ "endDate": {
+ "type": "number"
+ },
+ "frequency": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Vendor/{SoftLayer_Network_CdnMarketplace_VendorID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Vendor record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/getObject/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Vendor::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_CdnMarketplace_Vendor"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_CdnMarketplace_VendorID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_CdnMarketplace_Vendor object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_CdnMarketplace_Vendor/listVendors": {
+ "get": {
+ "description": null,
+ "summary": "SOAP API will return all CDN vendors available. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors/"
+ },
+ "operationId": "SoftLayer_Network_CdnMarketplace_Vendor::listVendors",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_CdnMarketplace_Vendor"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/addNetworkVlanTrunks": {
+ "post": {
+ "description": "Add VLANs as trunks to a network component. The VLANs given must be assigned to your account and belong to the same pod in which this network component and its hardware reside. The current native VLAN cannot be added as a trunk. \n\nThis method should be called on a network component of assigned hardware. A current list of VLAN trunks for a network component on a customer server can be found at 'uplinkComponent->networkVlanTrunks'. \n\nThis method returns an array of SoftLayer_Network_Vlans which were added as trunks. Any requested VLANs which are already trunked will be ignored and will not be returned. \n\nAffected VLANs will not yet be operational as trunks on the network upon return of this call, but activation will have been scheduled and should be considered imminent. The trunking records associated with the affected VLANs will maintain an 'isUpdating' value of '1' so long as this is the case. \n\nNote that in the event of an \"internal system error\" some VLANs may still have been affected and scheduled for activation. ",
+ "summary": "Add VLAN trunks to a network component",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/addNetworkVlanTrunks/"
+ },
+ "operationId": "SoftLayer_Network_Component::addNetworkVlanTrunks",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Component::addNetworkVlanTrunks::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Component::addNetworkVlanTrunks::Parameters::Input",
+ "properties": {
+ "networkVlans": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/clearNetworkVlanTrunks": {
+ "get": {
+ "description": "Remove all VLANs currently attached as trunks to this network component. \n\nThis method should be called on a network component of assigned hardware. A current list of VLAN trunks for a network component on a customer server can be found at 'uplinkComponent->networkVlanTrunks'. \n\nThis method returns an array of SoftLayer_Network_Vlans which will be removed as trunks. \n\nAffected VLANs will not yet be removed as trunks upon return of this call, but deactivation and removal will have been scheduled and should be considered imminent. The trunking records associated with the affected VLANs will maintain an 'isUpdating' value of '1' so long as this is the case. \n\nNote that in the event of a \"pending API request\" error some VLANs may still have been affected and scheduled for deactivation. ",
+ "summary": "Remove all VLAN trunks from a network component",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/clearNetworkVlanTrunks/"
+ },
+ "operationId": "SoftLayer_Network_Component::clearNetworkVlanTrunks",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Component record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Component::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getPortStatistics": {
+ "get": {
+ "description": "\n**DEPRECATED - This operation will cease to function after April 4th, 2016 and will be removed from v3.2**\nRetrieve various network statistics. The network statistics are retrieved from the network device using snmpget. Below is a list of statistics retrieved: \n* Administrative Status\n* Operational Status\n* Maximum Transmission Unit\n* In Octets\n* Out Octets\n* In Unicast Packets\n* Out Unicast Packets\n* In Multicast Packets\n* Out Multicast Packets",
+ "summary": "Retrieve various network statistics for the specific port.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getPortStatistics/"
+ },
+ "operationId": "SoftLayer_Network_Component::getPortStatistics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Port_Statistic"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/removeNetworkVlanTrunks": {
+ "post": {
+ "description": "Remove one or more VLANs currently attached as trunks to this network component. \n\nIf any VLANs are given which are not attached as trunks, they will be ignored. \n\nThis method should be called on a network component of assigned hardware. A current list of VLAN trunks for a network component on a customer server can be found at 'uplinkComponent->networkVlanTrunks'. \n\nThis method returns an array of SoftLayer_Network_Vlans which will be removed as trunks. Any requested VLANs which were not trunked will be ignored and will not be returned. \n\nAffected VLANs will not yet be removed as trunks upon return of this call, but deactivation and removal will have been scheduled and should be considered imminent. The trunking records associated with the affected VLANs will maintain an 'isUpdating' value of '1' so long as this is the case. \n\nNote that in the event of a \"pending API request\" error some VLANs may still have been affected and scheduled for deactivation. ",
+ "summary": "Remove VLAN trunks from a network component",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/removeNetworkVlanTrunks/"
+ },
+ "operationId": "SoftLayer_Network_Component::removeNetworkVlanTrunks",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Component::removeNetworkVlanTrunks::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Component::removeNetworkVlanTrunks::Parameters::Input",
+ "properties": {
+ "networkVlans": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getActiveCommand": {
+ "get": {
+ "description": "Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getActiveCommand/"
+ },
+ "operationId": "SoftLayer_Network_Component::getActiveCommand",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_Command_Request"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getDownlinkComponent": {
+ "get": {
+ "description": "The network component linking this object to a child device",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getDownlinkComponent/"
+ },
+ "operationId": "SoftLayer_Network_Component::getDownlinkComponent",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getDuplexMode": {
+ "get": {
+ "description": "The duplex mode of a network component.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getDuplexMode/"
+ },
+ "operationId": "SoftLayer_Network_Component::getDuplexMode",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component_Duplex_Mode"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getHardware": {
+ "get": {
+ "description": "The hardware that a network component resides in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getHardware/"
+ },
+ "operationId": "SoftLayer_Network_Component::getHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getHighAvailabilityFirewallFlag": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getHighAvailabilityFirewallFlag/"
+ },
+ "operationId": "SoftLayer_Network_Component::getHighAvailabilityFirewallFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getIpAddressBindings": {
+ "get": {
+ "description": "The records of all IP addresses bound to a network component.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getIpAddressBindings/"
+ },
+ "operationId": "SoftLayer_Network_Component::getIpAddressBindings",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getIpAddresses": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Component::getIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getLastCommand": {
+ "get": {
+ "description": "Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getLastCommand/"
+ },
+ "operationId": "SoftLayer_Network_Component::getLastCommand",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_Command_Request"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getMetricTrackingObject": {
+ "get": {
+ "description": "The metric tracking object for this network component.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getMetricTrackingObject/"
+ },
+ "operationId": "SoftLayer_Network_Component::getMetricTrackingObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getNetworkComponentFirewall": {
+ "get": {
+ "description": "The upstream network component firewall.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getNetworkComponentFirewall/"
+ },
+ "operationId": "SoftLayer_Network_Component::getNetworkComponentFirewall",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getNetworkComponentGroup": {
+ "get": {
+ "description": "A network component's associated group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getNetworkComponentGroup/"
+ },
+ "operationId": "SoftLayer_Network_Component::getNetworkComponentGroup",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component_Group"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getNetworkHardware": {
+ "get": {
+ "description": "All network devices in SoftLayer's network hierarchy that this device is connected to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getNetworkHardware/"
+ },
+ "operationId": "SoftLayer_Network_Component::getNetworkHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getNetworkVlan": {
+ "get": {
+ "description": "The VLAN that a network component's subnet is associated with.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getNetworkVlan/"
+ },
+ "operationId": "SoftLayer_Network_Component::getNetworkVlan",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getNetworkVlanTrunks": {
+ "get": {
+ "description": "The VLANs that are trunked to this network component.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getNetworkVlanTrunks/"
+ },
+ "operationId": "SoftLayer_Network_Component::getNetworkVlanTrunks",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component_Network_Vlan_Trunk"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getNetworkVlansTrunkable": {
+ "get": {
+ "description": "The viable trunking targets of this component. Viable targets include accessible VLANs in the same pod and network as this component, which are not already natively attached nor trunked to this component.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getNetworkVlansTrunkable/"
+ },
+ "operationId": "SoftLayer_Network_Component::getNetworkVlansTrunkable",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getPrimaryIpAddressRecord": {
+ "get": {
+ "description": "The primary IPv4 Address record for a network component.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getPrimaryIpAddressRecord/"
+ },
+ "operationId": "SoftLayer_Network_Component::getPrimaryIpAddressRecord",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getPrimarySubnet": {
+ "get": {
+ "description": "The subnet of the primary IP address assigned to this network component.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getPrimarySubnet/"
+ },
+ "operationId": "SoftLayer_Network_Component::getPrimarySubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getPrimaryVersion6IpAddressRecord": {
+ "get": {
+ "description": "The primary IPv6 Address record for a network component.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getPrimaryVersion6IpAddressRecord/"
+ },
+ "operationId": "SoftLayer_Network_Component::getPrimaryVersion6IpAddressRecord",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getRecentCommands": {
+ "get": {
+ "description": "The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getRecentCommands/"
+ },
+ "operationId": "SoftLayer_Network_Component::getRecentCommands",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_Command_Request"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getRedundancyCapableFlag": {
+ "get": {
+ "description": "Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getRedundancyCapableFlag/"
+ },
+ "operationId": "SoftLayer_Network_Component::getRedundancyCapableFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getRedundancyEnabledFlag": {
+ "get": {
+ "description": "Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getRedundancyEnabledFlag/"
+ },
+ "operationId": "SoftLayer_Network_Component::getRedundancyEnabledFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getRemoteManagementUsers": {
+ "get": {
+ "description": "User(s) credentials to issue commands and/or interact with the server's remote management card.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getRemoteManagementUsers/"
+ },
+ "operationId": "SoftLayer_Network_Component::getRemoteManagementUsers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_User"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getRouter": {
+ "get": {
+ "description": "A network component's routers.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getRouter/"
+ },
+ "operationId": "SoftLayer_Network_Component::getRouter",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getStorageNetworkFlag": {
+ "get": {
+ "description": "Whether a network component's primary ip address is from a storage network subnet or not. [Deprecated]",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getStorageNetworkFlag/"
+ },
+ "operationId": "SoftLayer_Network_Component::getStorageNetworkFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getSubnets": {
+ "get": {
+ "description": "A network component's subnets. A subnet is a group of IP addresses",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getSubnets/"
+ },
+ "operationId": "SoftLayer_Network_Component::getSubnets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getUplinkComponent": {
+ "get": {
+ "description": "The network component linking this object to parent",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getUplinkComponent/"
+ },
+ "operationId": "SoftLayer_Network_Component::getUplinkComponent",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getUplinkDuplexMode": {
+ "get": {
+ "description": "The duplex mode of the uplink network component linking to this object",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component/getUplinkDuplexMode/"
+ },
+ "operationId": "SoftLayer_Network_Component::getUplinkDuplexMode",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component_Duplex_Mode"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_ComponentID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getObject": {
+ "get": {
+ "description": "getObject returns a SoftLayer_Network_Firewall_Module_Context_Interface_AccessControlList_Network_Component object. You can only get objects for servers attached to your account that have a network firewall enabled. ",
+ "summary": "Retrieve a SoftLayer_Network_Component_Firewall record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component_Firewall/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Component_Firewall::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Component_FirewallID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component_Firewall object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/hasActiveTransactions": {
+ "get": {
+ "description": "Check for active transactions for the shared Firewall. ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component_Firewall/hasActiveTransactions/"
+ },
+ "operationId": "SoftLayer_Network_Component_Firewall::hasActiveTransactions",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Component_FirewallID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component_Firewall object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getApplyServerRuleSubnets": {
+ "get": {
+ "description": "The additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component_Firewall/getApplyServerRuleSubnets/"
+ },
+ "operationId": "SoftLayer_Network_Component_Firewall::getApplyServerRuleSubnets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Component_FirewallID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component_Firewall object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getBillingItem": {
+ "get": {
+ "description": "The billing item for a Hardware Firewall (Dedicated).",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component_Firewall/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_Component_Firewall::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Component_FirewallID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component_Firewall object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getGuestNetworkComponent": {
+ "get": {
+ "description": "The network component of the guest virtual server that this network component firewall belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component_Firewall/getGuestNetworkComponent/"
+ },
+ "operationId": "SoftLayer_Network_Component_Firewall::getGuestNetworkComponent",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Component_FirewallID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component_Firewall object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getNetworkComponent": {
+ "get": {
+ "description": "The network component of the switch interface that this network component firewall belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component_Firewall/getNetworkComponent/"
+ },
+ "operationId": "SoftLayer_Network_Component_Firewall::getNetworkComponent",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Component_FirewallID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component_Firewall object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getNetworkFirewallUpdateRequest": {
+ "get": {
+ "description": "The update requests made for this firewall.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component_Firewall/getNetworkFirewallUpdateRequest/"
+ },
+ "operationId": "SoftLayer_Network_Component_Firewall::getNetworkFirewallUpdateRequest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Component_FirewallID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component_Firewall object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getRules": {
+ "get": {
+ "description": "The currently running rule set of this network component firewall.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component_Firewall/getRules/"
+ },
+ "operationId": "SoftLayer_Network_Component_Firewall::getRules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall_Rule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Component_FirewallID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component_Firewall object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getSubnets": {
+ "get": {
+ "description": "The additional subnets linked to this network component firewall.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Component_Firewall/getSubnets/"
+ },
+ "operationId": "SoftLayer_Network_Component_Firewall::getSubnets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Component_FirewallID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Component_Firewall object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Customer_Subnet/createObject": {
+ "post": {
+ "description": "For IPSec network tunnels, customers can create their local subnets using this method. After the customer is created successfully, the customer subnet can then be added to the IPSec network tunnel. ",
+ "summary": "*",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Customer_Subnet/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Customer_Subnet::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Customer_Subnet"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Customer_Subnet::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Customer_Subnet::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Customer_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Customer_Subnet/{SoftLayer_Network_Customer_SubnetID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Network_Customer_Subnet object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Customer_Subnet service. You can only retrieve the subnet whose account matches the account that your portal user is assigned to. ",
+ "summary": "Retrieve a SoftLayer_Network_Customer_Subnet record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Customer_Subnet/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Customer_Subnet::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Customer_Subnet"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Customer_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Customer_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Customer_Subnet/{SoftLayer_Network_Customer_SubnetID}/getIpAddresses": {
+ "get": {
+ "description": "All ip addresses associated with a subnet.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Customer_Subnet/getIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Customer_Subnet::getIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Customer_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Customer_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Customer_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_DirectLink_Location/getAllObjects": {
+ "get": {
+ "description": "Return all existing Direct Link location. ",
+ "summary": "Get all existing Direct Link location. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_DirectLink_Location/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_DirectLink_Location::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_DirectLink_Location"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_DirectLink_Location/{SoftLayer_Network_DirectLink_LocationID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_DirectLink_Location record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_DirectLink_Location/getObject/"
+ },
+ "operationId": "SoftLayer_Network_DirectLink_Location::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_DirectLink_Location"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_DirectLink_LocationID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_DirectLink_Location object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_DirectLink_Location/{SoftLayer_Network_DirectLink_LocationID}/getLocation": {
+ "get": {
+ "description": "The location of Direct Link facility.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_DirectLink_Location/getLocation/"
+ },
+ "operationId": "SoftLayer_Network_DirectLink_Location::getLocation",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Location"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_DirectLink_LocationID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_DirectLink_Location object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_DirectLink_Location/{SoftLayer_Network_DirectLink_LocationID}/getProvider": {
+ "get": {
+ "description": "The Id of Direct Link provider.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_DirectLink_Location/getProvider/"
+ },
+ "operationId": "SoftLayer_Network_DirectLink_Location::getProvider",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_DirectLink_Provider"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_DirectLink_LocationID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_DirectLink_Location object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_DirectLink_Location/{SoftLayer_Network_DirectLink_LocationID}/getServiceType": {
+ "get": {
+ "description": "The Id of Direct Link service type.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_DirectLink_Location/getServiceType/"
+ },
+ "operationId": "SoftLayer_Network_DirectLink_Location::getServiceType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_DirectLink_ServiceType"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_DirectLink_LocationID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_DirectLink_Location object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_DirectLink_Provider/{SoftLayer_Network_DirectLink_ProviderID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_DirectLink_Provider record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_DirectLink_Provider/getObject/"
+ },
+ "operationId": "SoftLayer_Network_DirectLink_Provider::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_DirectLink_Provider"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_DirectLink_ProviderID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_DirectLink_Provider object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_DirectLink_ServiceType/{SoftLayer_Network_DirectLink_ServiceTypeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_DirectLink_ServiceType record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_DirectLink_ServiceType/getObject/"
+ },
+ "operationId": "SoftLayer_Network_DirectLink_ServiceType::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_DirectLink_ServiceType"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_DirectLink_ServiceTypeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_DirectLink_ServiceType object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_AccessControlList/{SoftLayer_Network_Firewall_AccessControlListID}/getObject": {
+ "get": {
+ "description": "getObject returns a SoftLayer_Network_Firewall_AccessControlList object. You can only get objects for servers attached to your account that have a network firewall enabled. ",
+ "summary": "Retrieve a SoftLayer_Network_Firewall_AccessControlList record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_AccessControlList/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_AccessControlList::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_AccessControlList"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_AccessControlListID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_AccessControlList object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_AccessControlList/{SoftLayer_Network_Firewall_AccessControlListID}/getNetworkFirewallUpdateRequests": {
+ "get": {
+ "description": "The update requests made for this firewall.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkFirewallUpdateRequests/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_AccessControlList::getNetworkFirewallUpdateRequests",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_AccessControlListID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_AccessControlList object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_AccessControlList/{SoftLayer_Network_Firewall_AccessControlListID}/getNetworkVlan": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkVlan/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_AccessControlList::getNetworkVlan",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_AccessControlListID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_AccessControlList object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_AccessControlList/{SoftLayer_Network_Firewall_AccessControlListID}/getRules": {
+ "get": {
+ "description": "The currently running rule set of this context access control list firewall.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_AccessControlList/getRules/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_AccessControlList::getRules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan_Firewall_Rule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_AccessControlListID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_AccessControlList object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Interface/{SoftLayer_Network_Firewall_InterfaceID}/getObject": {
+ "get": {
+ "description": "getObject returns a SoftLayer_Network_Firewall_Interface object. You can only get objects for servers attached to your account that have a network firewall enabled. ",
+ "summary": "Retrieve a SoftLayer_Network_Firewall_Interface record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Interface/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Interface::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Interface"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_InterfaceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Interface object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Interface/{SoftLayer_Network_Firewall_InterfaceID}/getFirewallContextAccessControlLists": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Interface/getFirewallContextAccessControlLists/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Interface::getFirewallContextAccessControlLists",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_AccessControlList"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_InterfaceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Interface object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Interface/{SoftLayer_Network_Firewall_InterfaceID}/getNetworkVlan": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Interface/getNetworkVlan/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Interface::getNetworkVlan",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_InterfaceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Interface object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Module_Context_Interface/{SoftLayer_Network_Firewall_Module_Context_InterfaceID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Firewall_Module_Context_Interface record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Module_Context_Interface::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Module_Context_Interface"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Module_Context_InterfaceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Module_Context_Interface object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Module_Context_Interface/{SoftLayer_Network_Firewall_Module_Context_InterfaceID}/getFirewallContextAccessControlLists": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getFirewallContextAccessControlLists/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Module_Context_Interface::getFirewallContextAccessControlLists",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_AccessControlList"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Module_Context_InterfaceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Module_Context_Interface object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Module_Context_Interface/{SoftLayer_Network_Firewall_Module_Context_InterfaceID}/getNetworkVlan": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getNetworkVlan/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Module_Context_Interface::getNetworkVlan",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Module_Context_InterfaceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Module_Context_Interface object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Template/getAllObjects": {
+ "get": {
+ "description": "Get all available firewall template objects. \n\n''getAllObjects'' returns an array of SoftLayer_Network_Firewall_Template objects upon success. ",
+ "summary": "Get all available firewall template objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Template/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Template::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Template"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Template/{SoftLayer_Network_Firewall_TemplateID}/getObject": {
+ "get": {
+ "description": "getObject returns a SoftLayer_Network_Firewall_Template object. You can retrieve all available firewall templates. getAllObjects returns an array of all available SoftLayer_Network_Firewall_Template objects. You can use these templates to generate a [[SoftLayer Network Firewall Update Request]]. \n\n@SLDNDocumentation Service See Also SoftLayer_Network_Firewall_Update_Request ",
+ "summary": "Retrieve a SoftLayer_Network_Firewall_Template record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Template/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Template::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Template"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_TemplateID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Template object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Template/{SoftLayer_Network_Firewall_TemplateID}/getRules": {
+ "get": {
+ "description": "The rule set that belongs to this firewall rules template.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Template/getRules/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Template::getRules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Template_Rule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_TemplateID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Template object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request/createObject": {
+ "post": {
+ "description": "Create a new firewall update request. If the SoftLayer_Network_Firewall_Update_Request object passed to this function has no rule, the firewall be set to bypass state and all the existing firewall rule(s) will be deleted. \n\n''createObject'' returns a Boolean ''true'' on successful object creation or ''false'' if your firewall update request was unable to be created. ",
+ "summary": "Create a new firewall update request.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Firewall_Update_Request::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Firewall_Update_Request::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request/getFirewallUpdateRequestRuleAttributes": {
+ "get": {
+ "description": "Get the possible attribute values for a firewall update request rule. These are the valid values which may be submitted as rule parameters for a firewall update request. \n\n''getFirewallUpdateRequestRuleAttributes'' returns a SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute object upon success. ",
+ "summary": "Get the possible attribute values for a firewall update request rule.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request/getFirewallUpdateRequestRuleAttributes/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request::getFirewallUpdateRequestRuleAttributes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request/{SoftLayer_Network_Firewall_Update_RequestID}/getObject": {
+ "get": {
+ "description": "''getObject'' returns a SoftLayer_Network_Firewall_Update_Request object. You can only get historical objects for servers attached to your account that have a network firewall enabled. ''createObject'' inserts a new SoftLayer_Network_Firewall_Update_Request object. You can only insert requests for servers attached to your account that have a network firewall enabled. ''getFirewallUpdateRequestRuleAttributes'' Get the possible attribute values for a firewall update request rule. ",
+ "summary": "Retrieve a SoftLayer_Network_Firewall_Update_Request record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Update_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Update_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request/updateRuleNote": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request/updateRuleNote/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request::updateRuleNote",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Firewall_Update_Request::updateRuleNote::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Firewall_Update_Request::updateRuleNote::Parameters::Input",
+ "properties": {
+ "fwRule": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall_Rule"
+ },
+ "note": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request/{SoftLayer_Network_Firewall_Update_RequestID}/getAuthorizingUser": {
+ "get": {
+ "description": "The user that authorized this firewall update request.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request/getAuthorizingUser/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request::getAuthorizingUser",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_User_Interface"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Update_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Update_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request/{SoftLayer_Network_Firewall_Update_RequestID}/getGuest": {
+ "get": {
+ "description": "The downstream virtual server that the rule set will be applied to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request/getGuest/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request::getGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Update_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Update_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request/{SoftLayer_Network_Firewall_Update_RequestID}/getHardware": {
+ "get": {
+ "description": "The downstream server that the rule set will be applied to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request/getHardware/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request::getHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Update_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Update_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request/{SoftLayer_Network_Firewall_Update_RequestID}/getNetworkComponentFirewall": {
+ "get": {
+ "description": "The network component firewall that the rule set will be applied to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request/getNetworkComponentFirewall/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request::getNetworkComponentFirewall",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Update_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Update_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request/{SoftLayer_Network_Firewall_Update_RequestID}/getRules": {
+ "get": {
+ "description": "The group of rules contained within the update request.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request/getRules/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request::getRules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request_Rule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Update_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Update_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request_Rule/createObject": {
+ "post": {
+ "description": "Create a new firewall update request. The SoftLayer_Network_Firewall_Update_Request object passed to this function must have at least one rule. \n\n''createObject'' returns a Boolean ''true'' on successful object creation or ''false'' if your firewall update request was unable to be created.. ",
+ "summary": "Create a new firewall update request rule.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request_Rule::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request_Rule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Firewall_Update_Request_Rule::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Firewall_Update_Request_Rule::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request_Rule"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request_Rule/{SoftLayer_Network_Firewall_Update_Request_RuleID}/getObject": {
+ "get": {
+ "description": "getObject returns a SoftLayer_Network_Firewall_Update_Request_Rule object. You can only get historical objects for servers attached to your account that have a network firewall enabled. createObject inserts a new SoftLayer_Network_Firewall_Update_Request_Rule object. Use the SoftLayer_Network_Firewall_Update_Request to create groups of rules for an update request. ",
+ "summary": "Retrieve a SoftLayer_Network_Firewall_Update_Request_Rule record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request_Rule::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request_Rule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Update_Request_RuleID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Update_Request_Rule object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request_Rule/validateRule": {
+ "post": {
+ "description": "Validate the supplied firewall request rule against the object it will apply to. For IPv4 rules, pass in an instance of SoftLayer_Network_Firewall_Update_Request_Rule. for IPv6 rules, pass in an instance of SoftLayer_Network_Firewall_Update_Request_Rule_Version6. The ID of the applied to object can either be applyToComponentId (an ID of a SoftLayer_Network_Component_Firewall) or applyToAclId (an ID of a SoftLayer_Network_Firewall_Module_Context_Interface_AccessControlList). One, and only one, of applyToComponentId and applyToAclId can be specified. \n\nIf validation is successful, nothing is returned. If validation is unsuccessful, an exception is thrown explaining the nature of the validation error. ",
+ "summary": "Validate a firewall update request rule.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/validateRule/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request_Rule::validateRule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Firewall_Update_Request_Rule::validateRule::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Firewall_Update_Request_Rule::validateRule::Parameters::Input",
+ "properties": {
+ "rule": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request_Rule"
+ },
+ "applyToComponentId": {
+ "type": "number"
+ },
+ "applyToAclId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Firewall_Update_Request_Rule/{SoftLayer_Network_Firewall_Update_Request_RuleID}/getFirewallUpdateRequest": {
+ "get": {
+ "description": "The update request that this rule belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getFirewallUpdateRequest/"
+ },
+ "operationId": "SoftLayer_Network_Firewall_Update_Request_Rule::getFirewallUpdateRequest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Firewall_Update_Request_RuleID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Firewall_Update_Request_Rule object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/bypassAllVlans": {
+ "get": {
+ "description": "Start the asynchronous process to bypass all VLANs. Any VLANs that are already bypassed will be ignored. The status field can be checked for progress. ",
+ "summary": "Bypass All VLANs",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/bypassAllVlans/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::bypassAllVlans",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/bypassVlans": {
+ "post": {
+ "description": "Start the asynchronous process to bypass the provided VLANs. The VLANs must already be attached. Any VLANs that are already bypassed will be ignored. The status field can be checked for progress. ",
+ "summary": "Bypass VLANs",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/bypassVlans/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::bypassVlans",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::bypassVlans::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::bypassVlans::Parameters::Input",
+ "properties": {
+ "vlans": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Vlan"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/forceRebuildCluster": {
+ "post": {
+ "description": "Purpose is to rebuild the target Gateway cluster with the specified OS price id. Method will remove the current OS and apply the default configuration settings. This will result in an extended OUTAGE!! Any custom configuration settings must be re-applied after the forced rebuild is completed. This is a DESTRUCTIVE action, use with caution. \n\n",
+ "summary": "Rebuild HA GAteway",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/forceRebuildCluster/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::forceRebuildCluster",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::forceRebuildCluster::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::forceRebuildCluster::Parameters::Input",
+ "properties": {
+ "osPriceId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getAllowedOsPriceIds": {
+ "post": {
+ "description": "Used to get a list of OS prices (ids) which are allowed for the Gateway. \n\n",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getAllowedOsPriceIds/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getAllowedOsPriceIds",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::getAllowedOsPriceIds::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::getAllowedOsPriceIds::Parameters::Input",
+ "properties": {
+ "memberId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getCapacity": {
+ "get": {
+ "description": "Returns the Gbps capacity of the gateway object \n\n",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getCapacity/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getCapacity",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getManufacturer": {
+ "post": {
+ "description": "Returns manufacturer name for a given gateway object. \n\n",
+ "summary": "manufacturer name",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getManufacturer/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getManufacturer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::getManufacturer::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::getManufacturer::Parameters::Input",
+ "properties": {
+ "checkSameOs": {
+ "type": "boolean"
+ },
+ "checkOsReloadMember": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getMemberGatewayImagesMatch": {
+ "get": {
+ "description": "Returns true if no mismatch is found, gateway is not Juniper vSRX or SA gateway \n\n",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getMemberGatewayImagesMatch/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getMemberGatewayImagesMatch",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Gateway record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPossibleInsideVlans": {
+ "get": {
+ "description": "Get all VLANs that can become inside VLANs on this gateway. This means the VLAN must not already be an inside VLAN, on the same router as this gateway, not a gateway transit VLAN, and not firewalled. ",
+ "summary": "Get Possible Inside VLANs",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getPossibleInsideVlans/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getPossibleInsideVlans",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getRollbackSupport": {
+ "get": {
+ "description": "Returns the following statuses SUPPORTED - rollback is supported and perform automatically UNSUPPORTED - rollback is not supported MANUAL - rollback can be performed but \n\n",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getRollbackSupport/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getRollbackSupport",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getUpgradeItemPrices": {
+ "get": {
+ "description": "Retrieve a list of upgradable items available for network gateways. ",
+ "summary": "Retrieve available upgrade prices",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getUpgradeItemPrices/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getUpgradeItemPrices",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/isLicenseServerAllowed": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/isLicenseServerAllowed/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::isLicenseServerAllowed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::isLicenseServerAllowed::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::isLicenseServerAllowed::Parameters::Input",
+ "properties": {
+ "licenseKeyName": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/manageLicenses": {
+ "post": {
+ "description": "Used to manage gateway require and add on licenses. If license request is valid for the gateway type a Gateway License Manage process will be created if licenses need to be adjusted on the gateway. \n\nrequiredItemKeyname - Item Key Name of the required license to be used on the gateway addOnLicenses - Json string containing an Add On license Item Key Name and requested total quantity to exist on each gateway member. Item Key Name must be associated with an Add On license product item and Item Key Name can only exist once in the json structure. \n\nExample : {\"ADD_ON_ITEM_KEYNAME_TYPE1\":3,\"ADD_ON_ITEM_KEYNAME_TYPE2\":4} \n\nNote, the quantity is not the requested change but total licences. For example, if current licenses for an Add On e.g. Remote VPN is 3 and the request is to add 1 more license then the quantity would be 4. If the request was to remove 1 license then the quantity would be 2. \n\n",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/manageLicenses/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::manageLicenses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::manageLicenses::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::manageLicenses::Parameters::Input",
+ "properties": {
+ "requiredItemKeyName": {
+ "type": "string"
+ },
+ "addOnLicenses": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/rebuildHACluster": {
+ "get": {
+ "description": "Rebuild a virtual gateway with HA cluster by destroying existing member gateway os and installing new os on both gateway members, then creating HA cluster between 2 members. This is a destructive process which will remove existing configuration and stop all gateway capabilities. vSRX will need to be re-configured after this operation. \n\n",
+ "summary": "Rebuild HA Gateway",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/rebuildHACluster/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::rebuildHACluster",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/rebuildvSRXHACluster": {
+ "get": {
+ "description": "Rebuild a vSRX gateway with HA cluster by destroying existing vSRX and installing new vSRX on both gateway servers, then creating HA cluster between 2 vSRX. This is a destructive process which will remove existing vSRX configuration and stop all gateway capabilities. vSRX will need to be re-configured after this operation. \n\n",
+ "summary": "Rebuild Juniper vSRX HA Gateway",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/rebuildvSRXHACluster/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::rebuildvSRXHACluster",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/refreshGatewayLicense": {
+ "get": {
+ "description": "Used to refresh the all licenses (Required and add ons) for Virtual gateways. License precheck must be ready. \n\n",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/refreshGatewayLicense/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::refreshGatewayLicense",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/rename": {
+ "post": {
+ "description": "Edit the name of this gateway. \n\n",
+ "summary": "Edit Gateway Name",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/rename/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::rename",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::rename::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::rename::Parameters::Input",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/setGatewayPassword": {
+ "post": {
+ "description": "Returns true if password change is successful, false if not successful \n\n",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/setGatewayPassword/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::setGatewayPassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::setGatewayPassword::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::setGatewayPassword::Parameters::Input",
+ "properties": {
+ "password": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/unbypassAllVlans": {
+ "get": {
+ "description": "Start the asynchronous process to unbypass all VLANs. Any VLANs that are already unbypassed will be ignored. The status field can be checked for progress. ",
+ "summary": "Bypass All VLANs",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/unbypassAllVlans/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::unbypassAllVlans",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/unbypassVlans": {
+ "post": {
+ "description": "Start the asynchronous process to unbypass the provided VLANs. The VLANs must already be attached. Any VLANs that are already unbypassed will be ignored. The status field can be checked for progress. ",
+ "summary": "Bypass VLANs",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/unbypassVlans/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::unbypassVlans",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::unbypassVlans::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::unbypassVlans::Parameters::Input",
+ "properties": {
+ "vlans": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Vlan"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/updateGatewayUserPassword": {
+ "post": {
+ "description": "The method updates the Gateway password for the provided username. It does not perform any synchronization with the Gateway to update the credentials. The method only updates the IMS db with the username / password record for the Gateway. \n\nThe 'username' and 'password' in the record template are required. 'username' must not be blank and must exist in the Gateway password records 'password' must not be blank \n\nReturns true if password change is successful, false if not successful \n\n",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/updateGatewayUserPassword/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::updateGatewayUserPassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::updateGatewayUserPassword::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway::updateGatewayUserPassword::Parameters::Input",
+ "properties": {
+ "record": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member_Passwords"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getAccount": {
+ "get": {
+ "description": "The account for this gateway.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getInsideVlans": {
+ "get": {
+ "description": "All VLANs trunked to this gateway.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getInsideVlans/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getInsideVlans",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Vlan"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getMembers": {
+ "get": {
+ "description": "The members for this gateway.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getMembers/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getNetworkFirewall": {
+ "get": {
+ "description": "The firewall associated with this gateway, if any.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getNetworkFirewall/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getNetworkFirewall",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan_Firewall"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getNetworkFirewallFlag": {
+ "get": {
+ "description": "Whether or not there is a firewall associated with this gateway.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getNetworkFirewallFlag/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getNetworkFirewallFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPrivateIpAddress": {
+ "get": {
+ "description": "The private gateway IP address.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getPrivateIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getPrivateIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPrivateVlan": {
+ "get": {
+ "description": "The private VLAN for accessing this gateway.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getPrivateVlan/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getPrivateVlan",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPublicIpAddress": {
+ "get": {
+ "description": "The public gateway IP address.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getPublicIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getPublicIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPublicIpv6Address": {
+ "get": {
+ "description": "The public gateway IPv6 address.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getPublicIpv6Address/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getPublicIpv6Address",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPublicVlan": {
+ "get": {
+ "description": "The public VLAN for accessing this gateway.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getPublicVlan/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getPublicVlan",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getStatus": {
+ "get": {
+ "description": "The current status of the gateway.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway/getStatus/"
+ },
+ "operationId": "SoftLayer_Network_Gateway::getStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Status"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_GatewayID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/createObject": {
+ "post": {
+ "description": "Create a new hardware member on the gateway. This also asynchronously sets up the network for this member. Progress of this process can be monitored via the gateway status. All members created with this object must have no VLANs attached. ",
+ "summary": "Add a member to a gateway",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Member::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Member::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/createObjects": {
+ "post": {
+ "description": "Create multiple new hardware members on the gateway. This also asynchronously sets up the network for the members. Progress of this process can be monitored via the gateway status. All members created with this object must have no VLANs attached. ",
+ "summary": "Add a member to a gateway",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/createObjects/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::createObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Member::createObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Member::createObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/editObject": {
+ "post": {
+ "description": "Edit this member, only manufacturer and version can be changed ",
+ "summary": "Edit Gateway Nmemnber",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Member::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Member::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Gateway_Member record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getAttributes": {
+ "get": {
+ "description": "The attributes for this member.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/getAttributes/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::getAttributes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member_Attribute"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getGatewaySoftwareDescription": {
+ "get": {
+ "description": "The gateway software description for the member.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/getGatewaySoftwareDescription/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::getGatewaySoftwareDescription",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Software_Description"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getHardware": {
+ "get": {
+ "description": "The device for this member.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/getHardware/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::getHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getLicenses": {
+ "get": {
+ "description": "The gateway licenses for this member.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/getLicenses/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::getLicenses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member_Licenses"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getNetworkGateway": {
+ "get": {
+ "description": "The gateway this member belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/getNetworkGateway/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::getNetworkGateway",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getPasswords": {
+ "get": {
+ "description": "The gateway passwords for this member.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/getPasswords/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::getPasswords",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member_Passwords"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getPublicIpAddress": {
+ "get": {
+ "description": "The public gateway IP address.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member/getPublicIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member::getPublicIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member_Attribute/{SoftLayer_Network_Gateway_Member_AttributeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Gateway_Member_Attribute record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member_Attribute::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member_Attribute"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_Member_AttributeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member_Attribute object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Member_Attribute/{SoftLayer_Network_Gateway_Member_AttributeID}/getGatewayMember": {
+ "get": {
+ "description": "The gateway member has these attributes.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getGatewayMember/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Member_Attribute::getGatewayMember",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_Member_AttributeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Member_Attribute object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Precheck/{SoftLayer_Network_Gateway_PrecheckID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Gateway_Precheck record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Precheck/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Precheck::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Precheck"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_PrecheckID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Precheck object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Precheck/getPrecheckStatus": {
+ "post": {
+ "description": "Get the precheck status for all Virtual (Juniper, Fortigate vFSA) Gateway Action categories which require a readiness check before executing. Reference cloud.ibm.com documentation for more details. \n\nPossible precheck readiness values include: \n\nReady (0): The member or Gateway category is ready. The only state that will be allowed to execute the Action. Not Ready (1): The member or Gateway category is not ready. This could occur because of several reasons. Either a precheck error occur, or the precheck has not run within the precheck timeout window. Check the returnCode for details on the specific error. Reference the cloud.ibm.com documentation for recovery details. Running (2): The precheck is currently running with no errors. Incomplete (3): The other member in the Gateway failed, therefore the current member could not complete it's precheck. Unsupported (4): The category is unsupported for the given member or Gateway. Expired (5) : The precheck record has expired so will need to be run again. Unchecked (6) : The precheck for the category has never been run. Current (7) : The gateway state is current so running precheck is not required. This commonly relates to version upgrade if gateway is in most update version. \n\nReturn Values: Array of objects \n\nObject Definition: \n\ncategory : String : The precheck category which corresponds to one or more executeable actions. \n\nCurrent categories include: upgrade_precheck : Required for major and minor upgrade version actions. license_precheck : Required for license upgrade and downgrade actions. reload_precheck : Required for OS Reload action. rollback_precheck : Optional and related to upgrade_precheck. Only returned if getRollbackPrecheck is provided and set to True (1). \n\n\n\nmemberId : Integer : The softlayer member id. memberReadinessValue : String : The precheck readiness state for the member. See possible readiness values above. gatewayReadinessValue : String : The precheck readiness state for the gateway : See possible readiness values above. returnCode : Integer : The return code. 0 if no error. Reference cloud.ibm.com documentation for details. \n\n",
+ "summary": "Get Precheck status for Gateway",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Precheck/getPrecheckStatus/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Precheck::getPrecheckStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Precheck"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Precheck::getPrecheckStatus::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Precheck::getPrecheckStatus::Parameters::Input",
+ "properties": {
+ "gatewayId": {
+ "type": "number"
+ },
+ "getRollbackPrecheck": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_Precheck/licenseManagementPrecheck": {
+ "post": {
+ "description": "Used to create a License Management Network Gateway Precheck transaction. \n\n",
+ "summary": "License Management Gateway Precheck",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Precheck/licenseManagementPrecheck/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Precheck::licenseManagementPrecheck",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Precheck::licenseManagementPrecheck::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Precheck::licenseManagementPrecheck::Parameters::Input",
+ "properties": {
+ "gatewayId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_Precheck/osReloadPrecheck": {
+ "post": {
+ "description": "Create an OS Reload Network Gateway Precheck transaction. \n\n",
+ "summary": "OS Reload Gateway Precheck",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Precheck/osReloadPrecheck/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Precheck::osReloadPrecheck",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Precheck::osReloadPrecheck::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Precheck::osReloadPrecheck::Parameters::Input",
+ "properties": {
+ "gatewayId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_Precheck/upgradePrecheck": {
+ "post": {
+ "description": "Create a Upgrade Network Gateway Precheck transaction. \n\n",
+ "summary": "Upgrade Gateway Precheck",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Precheck/upgradePrecheck/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Precheck::upgradePrecheck",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Precheck::upgradePrecheck::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Precheck::upgradePrecheck::Parameters::Input",
+ "properties": {
+ "gatewayId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_Status/{SoftLayer_Network_Gateway_StatusID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Gateway_Status record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Status/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Status::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Status"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_StatusID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Status object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_VersionUpgrade/getAllUpgradesByGatewayId": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllUpgradesByGatewayId/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_VersionUpgrade::getAllUpgradesByGatewayId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_VersionUpgrade"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_VersionUpgrade::getAllUpgradesByGatewayId::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_VersionUpgrade::getAllUpgradesByGatewayId::Parameters::Input",
+ "properties": {
+ "gatewayId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_VersionUpgrade/getGwOrdersAllowedLicenses": {
+ "post": {
+ "description": "\n\n\n\n",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getGwOrdersAllowedLicenses/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_VersionUpgrade::getGwOrdersAllowedLicenses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_VersionUpgrade::getGwOrdersAllowedLicenses::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_VersionUpgrade::getGwOrdersAllowedLicenses::Parameters::Input",
+ "properties": {
+ "accountId": {
+ "type": "number"
+ },
+ "manufacturer": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_VersionUpgrade/getGwOrdersAllowedOS": {
+ "post": {
+ "description": "Used to get a list per package of prices ids for allowed vSRX or vFSA OS-es for new orders. \n\n",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getGwOrdersAllowedOS/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_VersionUpgrade::getGwOrdersAllowedOS",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Item_Prices"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_VersionUpgrade::getGwOrdersAllowedOS::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_VersionUpgrade::getGwOrdersAllowedOS::Parameters::Input",
+ "properties": {
+ "accountId": {
+ "type": "number"
+ },
+ "manufacturer": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_VersionUpgrade/{SoftLayer_Network_Gateway_VersionUpgradeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Gateway_VersionUpgrade record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_VersionUpgrade::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_VersionUpgrade"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_VersionUpgradeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_VersionUpgrade object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_VersionUpgrade/{SoftLayer_Network_Gateway_VersionUpgradeID}/validateVersionChange": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/validateVersionChange/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_VersionUpgrade::validateVersionChange",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_VersionUpgrade::validateVersionChange::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_VersionUpgrade::validateVersionChange::Parameters::Input",
+ "properties": {
+ "gatewayId": {
+ "type": "number"
+ },
+ "versionUpgradeId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_VersionUpgradeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_VersionUpgrade object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Vlan/{SoftLayer_Network_Gateway_VlanID}/bypass": {
+ "get": {
+ "description": "Start the asynchronous process to bypass/unroute the VLAN from this gateway. ",
+ "summary": "Bypass VLAN",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Vlan/bypass/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Vlan::bypass",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_VlanID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Vlan object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Vlan/createObject": {
+ "post": {
+ "description": "Create a new VLAN attachment. If the bypassFlag is false, this will also create an asynchronous process to route the VLAN through the gateway. ",
+ "summary": "Attach a VLAN to a gateway",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Vlan/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Vlan::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Vlan"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Vlan::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Vlan::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Vlan"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_Vlan/createObjects": {
+ "post": {
+ "description": "Create multiple new VLAN attachments. If the bypassFlag is false, this will also create an asynchronous process to route the VLANs through the gateway. ",
+ "summary": "Attach a VLAN to a gateway",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Vlan/createObjects/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Vlan::createObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Vlan"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Vlan::createObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Vlan::createObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Vlan"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_Vlan/{SoftLayer_Network_Gateway_VlanID}/deleteObject": {
+ "get": {
+ "description": "Start the asynchronous process to detach this VLANs from the gateway. ",
+ "summary": "Detach VLAN",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Vlan::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_VlanID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Vlan object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Vlan/deleteObjects": {
+ "post": {
+ "description": "Detach several VLANs. This will not detach them right away, but rather start an asynchronous process to detach. ",
+ "summary": "Attach a VLAN to a gateway",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObjects/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Vlan::deleteObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Vlan::deleteObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Gateway_Vlan::deleteObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Vlan"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Gateway_Vlan/{SoftLayer_Network_Gateway_VlanID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Gateway_Vlan record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Vlan/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Vlan::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Vlan"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_VlanID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Vlan object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Vlan/{SoftLayer_Network_Gateway_VlanID}/unbypass": {
+ "get": {
+ "description": "Start the asynchronous process to route the VLAN to this gateway. ",
+ "summary": "Unbypass VLAN",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Vlan/unbypass/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Vlan::unbypass",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_VlanID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Vlan object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Vlan/{SoftLayer_Network_Gateway_VlanID}/getNetworkGateway": {
+ "get": {
+ "description": "The gateway this VLAN is attached to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkGateway/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Vlan::getNetworkGateway",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Gateway"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_VlanID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Vlan object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Gateway_Vlan/{SoftLayer_Network_Gateway_VlanID}/getNetworkVlan": {
+ "get": {
+ "description": "The network VLAN record.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkVlan/"
+ },
+ "operationId": "SoftLayer_Network_Gateway_Vlan::getNetworkVlan",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Vlan"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Gateway_VlanID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Gateway_Vlan object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/allowDeleteConnection": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/allowDeleteConnection/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::allowDeleteConnection",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::allowDeleteConnection::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::allowDeleteConnection::Parameters::Input",
+ "properties": {
+ "serviceKey": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/createConnection": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/createConnection/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::createConnection",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::createConnection::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::createConnection::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Interconnect_Tenant"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/deleteConnection": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/deleteConnection/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::deleteConnection",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::deleteConnection::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::deleteConnection::Parameters::Input",
+ "properties": {
+ "receivedObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Interconnect_Tenant"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/editConnection": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/editConnection/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::editConnection",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::editConnection::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::editConnection::Parameters::Input",
+ "properties": {
+ "receivedObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Interconnect_Tenant"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/getAllConnections": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllConnections/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getAllConnections",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Interconnect_Tenant"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/getAllPortLabelsWithCurrentUsage": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllPortLabelsWithCurrentUsage/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getAllPortLabelsWithCurrentUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::getAllPortLabelsWithCurrentUsage::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::getAllPortLabelsWithCurrentUsage::Parameters::Input",
+ "properties": {
+ "directLinkLocationId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/getBgpIpRange": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getBgpIpRange/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getBgpIpRange",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/getConnection": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getConnection/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getConnection",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::getConnection::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::getConnection::Parameters::Input",
+ "properties": {
+ "serviceKey": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/getDirectLinkSpeeds": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getDirectLinkSpeeds/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getDirectLinkSpeeds",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::getDirectLinkSpeeds::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::getDirectLinkSpeeds::Parameters::Input",
+ "properties": {
+ "offeringType": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/getNetworkZones": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getNetworkZones/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getNetworkZones",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Interconnect_Tenant record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Interconnect_Tenant"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Interconnect_TenantID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Interconnect_Tenant object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/getPorts": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getPorts/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getPorts",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::getPorts::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::getPorts::Parameters::Input",
+ "properties": {
+ "provider": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/rejectApprovalRequests": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/rejectApprovalRequests/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::rejectApprovalRequests",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::rejectApprovalRequests::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::rejectApprovalRequests::Parameters::Input",
+ "properties": {
+ "serviceKey": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/updateConnectionStatus": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/updateConnectionStatus/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::updateConnectionStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::updateConnectionStatus::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Interconnect_Tenant::updateConnectionStatus::Parameters::Input",
+ "properties": {
+ "tenantId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getBillingItem": {
+ "get": {
+ "description": "The active billing item for a network interconnect.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item_Network_Interconnect"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Interconnect_TenantID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Interconnect_Tenant object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getDatacenterName": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getDatacenterName/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getDatacenterName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Interconnect_TenantID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Interconnect_Tenant object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getPortLabel": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getPortLabel/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getPortLabel",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Interconnect_TenantID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Interconnect_Tenant object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getServiceType": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getServiceType/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getServiceType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_DirectLink_ServiceType"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Interconnect_TenantID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Interconnect_Tenant object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getVendorName": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getVendorName/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getVendorName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Interconnect_TenantID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Interconnect_Tenant object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getZoneName": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Interconnect_Tenant/getZoneName/"
+ },
+ "operationId": "SoftLayer_Network_Interconnect_Tenant::getZoneName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Interconnect_TenantID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Interconnect_Tenant object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_HealthMonitor/{SoftLayer_Network_LBaaS_HealthMonitorID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_LBaaS_HealthMonitor record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_HealthMonitor::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_HealthMonitor"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_HealthMonitorID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_HealthMonitor object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_HealthMonitor/updateLoadBalancerHealthMonitors": {
+ "post": {
+ "description": "Update load balancers health monitor and return load balancer object with listeners (frontend), pools (backend), health monitor server instances (members) and datacenter populated ",
+ "summary": "Update load balancer health monitors",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/updateLoadBalancerHealthMonitors/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_HealthMonitor::updateLoadBalancerHealthMonitors",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_HealthMonitor::updateLoadBalancerHealthMonitors::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_HealthMonitor::updateLoadBalancerHealthMonitors::Parameters::Input",
+ "properties": {
+ "loadBalancerUuid": {
+ "type": "string"
+ },
+ "healthMonitorConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Member/addL7PoolMembers": {
+ "post": {
+ "description": "Add server instances as members to a L7pool and return the LoadBalancer Object with listeners, pools and members populated ",
+ "summary": "Add load balancer L7 members",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Member/addL7PoolMembers/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Member::addL7PoolMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Member::addL7PoolMembers::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Member::addL7PoolMembers::Parameters::Input",
+ "properties": {
+ "l7PoolUuid": {
+ "type": "string"
+ },
+ "memberInstances": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Member"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Member/deleteL7PoolMembers": {
+ "post": {
+ "description": "Delete given members from load balancer and return load balancer object with listeners, pools and members populated ",
+ "summary": "Delete load balancer members",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Member/deleteL7PoolMembers/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Member::deleteL7PoolMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Member::deleteL7PoolMembers::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Member::deleteL7PoolMembers::Parameters::Input",
+ "properties": {
+ "l7PoolUuid": {
+ "type": "string"
+ },
+ "memberUuids": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Member/{SoftLayer_Network_LBaaS_L7MemberID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_LBaaS_L7Member record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Member/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Member::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Member"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Member/updateL7PoolMembers": {
+ "post": {
+ "description": "Update L7 members weight and port. ",
+ "summary": "Update l7 members weight and port",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Member/updateL7PoolMembers/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Member::updateL7PoolMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Member::updateL7PoolMembers::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Member::updateL7PoolMembers::Parameters::Input",
+ "properties": {
+ "l7PoolUuid": {
+ "type": "string"
+ },
+ "members": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Member"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Policy/addL7Policies": {
+ "post": {
+ "description": "This function creates multiple policies with rules for the given listener. ",
+ "summary": "Create layer 7 policies with rules for the given listener. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Policy/addL7Policies/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Policy::addL7Policies",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Policy::addL7Policies::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Policy::addL7Policies::Parameters::Input",
+ "properties": {
+ "listenerUuid": {
+ "type": "string"
+ },
+ "policiesRules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_PolicyRule"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Policy/{SoftLayer_Network_LBaaS_L7PolicyID}/deleteObject": {
+ "get": {
+ "description": "Deletes a l7 policy instance and the rules associated with the policy ",
+ "summary": "Deletes a l7 policy instance and the rules associated with the policy",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Policy/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Policy::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7PolicyID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Policy object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Policy/{SoftLayer_Network_LBaaS_L7PolicyID}/editObject": {
+ "post": {
+ "description": "Edit a l7 policy instance's properties ",
+ "summary": "Edit a l7 policy instance's properties",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Policy/editObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Policy::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Policy::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Policy::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Policy"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7PolicyID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Policy object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Policy/{SoftLayer_Network_LBaaS_L7PolicyID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_LBaaS_L7Policy record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Policy/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Policy::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Policy"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7PolicyID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Policy object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Policy/{SoftLayer_Network_LBaaS_L7PolicyID}/getL7Rules": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Policy/getL7Rules/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Policy::getL7Rules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Rule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7PolicyID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Policy object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Pool/createL7Pool": {
+ "post": {
+ "description": "Create a backend to be used for L7 load balancing. This L7 pool has backend protocol, L7 members, L7 health monitor and session affinity. L7 pool is associated with L7 policies. ",
+ "summary": "create L7 pools",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Pool/createL7Pool/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Pool::createL7Pool",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Pool::createL7Pool::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Pool::createL7Pool::Parameters::Input",
+ "properties": {
+ "loadBalancerUuid": {
+ "type": "string"
+ },
+ "l7Pool": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Pool"
+ },
+ "l7Members": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Member"
+ }
+ },
+ "l7HealthMonitor": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7HealthMonitor"
+ },
+ "l7SessionAffinity": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7SessionAffinity"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/deleteObject": {
+ "get": {
+ "description": "Deletes an existing L7 pool along with L7 members, L7 health monitor, and L7 session affinity. ",
+ "summary": "deletes L7 pools",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Pool/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Pool::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7PoolID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Pool object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Pool/getL7PoolMemberHealth": {
+ "post": {
+ "description": "Returns the health of all L7 pool's members which are created under load balancer. L7 members health status is available only after a L7 pool is associated with the L7 policy and that L7 policy has at least one L7 rule. ",
+ "summary": "Return load balancer's all L7 pools members health",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7PoolMemberHealth/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Pool::getL7PoolMemberHealth",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7PoolMembersHealth"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Pool::getL7PoolMemberHealth::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Pool::getL7PoolMemberHealth::Parameters::Input",
+ "properties": {
+ "loadBalancerUuid": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_LBaaS_L7Pool record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Pool/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Pool::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Pool"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7PoolID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Pool object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Pool/updateL7Pool": {
+ "post": {
+ "description": "Updates an existing L7 pool, L7 health monitor and L7 session affinity. ",
+ "summary": "updates L7 pools",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Pool/updateL7Pool/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Pool::updateL7Pool",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Pool::updateL7Pool::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Pool::updateL7Pool::Parameters::Input",
+ "properties": {
+ "l7PoolUuid": {
+ "type": "string"
+ },
+ "l7Pool": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Pool"
+ },
+ "l7HealthMonitor": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7HealthMonitor"
+ },
+ "l7SessionAffinity": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7SessionAffinity"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/getL7HealthMonitor": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7HealthMonitor/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Pool::getL7HealthMonitor",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7HealthMonitor"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7PoolID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Pool object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/getL7Members": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Members/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Pool::getL7Members",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7PoolID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Pool object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/getL7Policies": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Policies/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Pool::getL7Policies",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Policy"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7PoolID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Pool object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/getL7SessionAffinity": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7SessionAffinity/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Pool::getL7SessionAffinity",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7SessionAffinity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7PoolID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Pool object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Rule/addL7Rules": {
+ "post": {
+ "description": "This function creates and adds multiple Rules to a given L7 policy with all the details provided for rules ",
+ "summary": "Create and add a L7 Rule to a given L7 policy with the provided rules details. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Rule/addL7Rules/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Rule::addL7Rules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Rule::addL7Rules::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Rule::addL7Rules::Parameters::Input",
+ "properties": {
+ "policyUuid": {
+ "type": "string"
+ },
+ "rules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Rule"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Rule/deleteL7Rules": {
+ "post": {
+ "description": "This function deletes multiple rules aassociated with the same policy. ",
+ "summary": "Delete one or more rules associated with the same policy. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Rule/deleteL7Rules/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Rule::deleteL7Rules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Rule::deleteL7Rules::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Rule::deleteL7Rules::Parameters::Input",
+ "properties": {
+ "policyUuid": {
+ "type": "string"
+ },
+ "ruleUuids": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Rule/{SoftLayer_Network_LBaaS_L7RuleID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_LBaaS_L7Rule record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Rule/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Rule::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Rule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_L7RuleID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_L7Rule object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_L7Rule/updateL7Rules": {
+ "post": {
+ "description": "This function updates multiple Rules to a given policy with all the details for rules. ",
+ "summary": "Update one or more rules associated with the same policy. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_L7Rule/updateL7Rules/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_L7Rule::updateL7Rules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Rule::updateL7Rules::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_L7Rule::updateL7Rules::Parameters::Input",
+ "properties": {
+ "policyUuid": {
+ "type": "string"
+ },
+ "rules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Rule"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_Listener/deleteLoadBalancerProtocols": {
+ "post": {
+ "description": "Delete load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated. ",
+ "summary": "Delete load balancers front- and backend protocols",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_Listener/deleteLoadBalancerProtocols/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_Listener::deleteLoadBalancerProtocols",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_Listener::deleteLoadBalancerProtocols::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_Listener::deleteLoadBalancerProtocols::Parameters::Input",
+ "properties": {
+ "loadBalancerUuid": {
+ "type": "string"
+ },
+ "listenerUuids": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_Listener/{SoftLayer_Network_LBaaS_ListenerID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_LBaaS_Listener record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_Listener/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_Listener::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_Listener"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_ListenerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_Listener object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_Listener/updateLoadBalancerProtocols": {
+ "post": {
+ "description": "Update (create) load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated. Note if a protocolConfiguration has no listenerUuid set, this function will create the specified front- and backend accordingly. Otherwise the given front- and backend will be updated with the new protocol and port. ",
+ "summary": "Update/create load balancers protocols",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_Listener/updateLoadBalancerProtocols/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_Listener::updateLoadBalancerProtocols",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_Listener::updateLoadBalancerProtocols::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_Listener::updateLoadBalancerProtocols::Parameters::Input",
+ "properties": {
+ "loadBalancerUuid": {
+ "type": "string"
+ },
+ "protocolConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_Listener/{SoftLayer_Network_LBaaS_ListenerID}/getDefaultPool": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_Listener/getDefaultPool/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_Listener::getDefaultPool",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_Pool"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_ListenerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_Listener object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_Listener/{SoftLayer_Network_LBaaS_ListenerID}/getL7Policies": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_Listener/getL7Policies/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_Listener::getL7Policies",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Policy"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_ListenerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_Listener object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/cancelLoadBalancer": {
+ "post": {
+ "description": "Cancel a load balancer with the given uuid. The billing system will execute the deletion of load balancer and all objects associated with it such as load balancer appliances, listeners, pools and members in the background. ",
+ "summary": "Cancel the specified load balancer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/cancelLoadBalancer/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::cancelLoadBalancer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::cancelLoadBalancer::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::cancelLoadBalancer::Parameters::Input",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/enableOrDisableDataLogs": {
+ "post": {
+ "description": "When enabled, data log would be forwarded to logging service. ",
+ "summary": "Enable or disable data logs forwarding. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/enableOrDisableDataLogs/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::enableOrDisableDataLogs",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::enableOrDisableDataLogs::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::enableOrDisableDataLogs::Parameters::Input",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ },
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/getAllObjects": {
+ "get": {
+ "description": "Return all existing load balancers ",
+ "summary": "Get all existing load balancers. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/getAppliances": {
+ "post": {
+ "description": "Get the load balancer appliances for the given lb id. ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getAppliances/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getAppliances",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancerAppliance"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getAppliances::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getAppliances::Parameters::Input",
+ "properties": {
+ "lbId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/getListenerTimeSeriesData": {
+ "post": {
+ "description": "Return listener time series datapoints. The time series data is available for Throughput, ConnectionRate and ActiveConnections. Throughput is in bits per second. The values are an average over the time range. The time series data is available for 1hour, 6hours, 12hours, 1day, 1week or 2weeks. \n\n",
+ "summary": "Return time series datapoints",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListenerTimeSeriesData/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getListenerTimeSeriesData",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancerMonitoringMetricDataPoint"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getListenerTimeSeriesData::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getListenerTimeSeriesData::Parameters::Input",
+ "properties": {
+ "loadBalancerUuid": {
+ "type": "string"
+ },
+ "metricName": {
+ "type": "string"
+ },
+ "timeRange": {
+ "type": "string"
+ },
+ "listenerUuid": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancer": {
+ "post": {
+ "description": "Get the load balancer object with given uuid. ",
+ "summary": "Get a specific load balancer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancer/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancer::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancer::Parameters::Input",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerMemberHealth": {
+ "post": {
+ "description": "Return load balancer members health ",
+ "summary": "Return load balancer members health",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerMemberHealth/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancerMemberHealth",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_PoolMembersHealth"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancerMemberHealth::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancerMemberHealth::Parameters::Input",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerStatistics": {
+ "post": {
+ "description": "Return load balancers statistics such as total number of current sessions and total number of accumulated connections. ",
+ "summary": "Return load balancers statistics",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerStatistics/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancerStatistics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancerStatistics"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancerStatistics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancerStatistics::Parameters::Input",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancers": {
+ "post": {
+ "description": "Get the load balancer objects for the given user accounts. ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancers/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancers::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::getLoadBalancers::Parameters::Input",
+ "properties": {
+ "data": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_LBaaS_LoadBalancer record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_LoadBalancerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_LoadBalancer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/serviceDNS": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/serviceDNS/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::serviceDNS",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::serviceDNS::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::serviceDNS::Parameters::Input",
+ "properties": {
+ "data": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/serviceLoadBalancer": {
+ "post": {
+ "description": null,
+ "summary": "Service function for a load balancer. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/serviceLoadBalancer/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::serviceLoadBalancer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::serviceLoadBalancer::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::serviceLoadBalancer::Parameters::Input",
+ "properties": {
+ "data": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/updateLoadBalancer": {
+ "post": {
+ "description": "Update load balancer's description, and return the load balancer object containing all listeners, pools, members and datacenter. ",
+ "summary": "Update a load balancer's description.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateLoadBalancer/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::updateLoadBalancer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::updateLoadBalancer::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::updateLoadBalancer::Parameters::Input",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ },
+ "newDescription": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/updateSslCiphers": {
+ "post": {
+ "description": "Updates the load balancer with the new cipher list. All new connections going forward will use the new set of ciphers selected by the user. ",
+ "summary": "Updates the cipher list of the load balancer",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateSslCiphers/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::updateSslCiphers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::updateSslCiphers::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_LoadBalancer::updateSslCiphers::Parameters::Input",
+ "properties": {
+ "loadBalancerUuid": {
+ "type": "string"
+ },
+ "cipherList": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getDatacenter": {
+ "get": {
+ "description": "Datacenter, where load balancer is located.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getDatacenter/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getDatacenter",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Location"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_LoadBalancerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_LoadBalancer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getHealthMonitors": {
+ "get": {
+ "description": "Health monitors for the backend members.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getHealthMonitors/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getHealthMonitors",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_HealthMonitor"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_LoadBalancerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_LoadBalancer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getL7Pools": {
+ "get": {
+ "description": "L7Pools for load balancer.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getL7Pools/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getL7Pools",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_L7Pool"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_LoadBalancerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_LoadBalancer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getListeners": {
+ "get": {
+ "description": "Listeners assigned to load balancer.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListeners/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getListeners",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_Listener"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_LoadBalancerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_LoadBalancer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getMembers": {
+ "get": {
+ "description": "Members assigned to load balancer.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getMembers/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_Member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_LoadBalancerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_LoadBalancer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getSslCiphers": {
+ "get": {
+ "description": "list of preferred custom ciphers configured for the load balancer.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getSslCiphers/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancer::getSslCiphers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_SSLCipher"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_LoadBalancerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_LoadBalancer object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_LoadBalancerAppliance/{SoftLayer_Network_LBaaS_LoadBalancerApplianceID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_LBaaS_LoadBalancerAppliance record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_LoadBalancerAppliance/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_LoadBalancerAppliance::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancerAppliance"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_LoadBalancerApplianceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_LoadBalancerAppliance object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_Member/addLoadBalancerMembers": {
+ "post": {
+ "description": "Add server instances as members to load balancer and return it with listeners, pools and members populated ",
+ "summary": "Add load balancer members",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_Member/addLoadBalancerMembers/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_Member::addLoadBalancerMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_Member::addLoadBalancerMembers::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_Member::addLoadBalancerMembers::Parameters::Input",
+ "properties": {
+ "loadBalancerUuid": {
+ "type": "string"
+ },
+ "serverInstances": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_Member/deleteLoadBalancerMembers": {
+ "post": {
+ "description": "Delete given members from load balancer and return load balancer object with listeners, pools and members populated ",
+ "summary": "Delete load balancer members",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_Member/deleteLoadBalancerMembers/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_Member::deleteLoadBalancerMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_Member::deleteLoadBalancerMembers::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_Member::deleteLoadBalancerMembers::Parameters::Input",
+ "properties": {
+ "loadBalancerUuid": {
+ "type": "string"
+ },
+ "memberUuids": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_Member/{SoftLayer_Network_LBaaS_MemberID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_LBaaS_Member record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_Member/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_Member::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_Member"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_MemberID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_Member object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_Member/updateLoadBalancerMembers": {
+ "post": {
+ "description": "Update members weight and return load balancer object with listeners, pools and members populated ",
+ "summary": "Update members weight",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_Member/updateLoadBalancerMembers/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_Member::updateLoadBalancerMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_LoadBalancer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_Member::updateLoadBalancerMembers::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LBaaS_Member::updateLoadBalancerMembers::Parameters::Input",
+ "properties": {
+ "loadBalancerUuid": {
+ "type": "string"
+ },
+ "members": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_Member"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_LBaaS_SSLCipher/getAllObjects": {
+ "get": {
+ "description": "Returns all supported cipher list ",
+ "summary": "Get all supported ciphers. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_SSLCipher::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_SSLCipher"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LBaaS_SSLCipher/{SoftLayer_Network_LBaaS_SSLCipherID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_LBaaS_SSLCipher record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LBaaS_SSLCipher::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_SSLCipher"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LBaaS_SSLCipherID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LBaaS_SSLCipher object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_Service/{SoftLayer_Network_LoadBalancer_ServiceID}/deleteObject": {
+ "get": {
+ "description": "Calling deleteObject on a particular server will remove it from the load balancer. This is the only way to remove a service from your load balancer. If you wish to remove a server, first call this function, then reload the virtualIpAddress object and edit the remaining services to reflect the other changes that you wish to make. ",
+ "summary": "Delete this service, removing it from the load balancer.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_Service/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_Service::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_Service/{SoftLayer_Network_LoadBalancer_ServiceID}/getGraphImage": {
+ "post": {
+ "description": "Get the graph image for a load balancer 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'. \n\nThis method returns the raw binary image data. ",
+ "summary": "Get the connection or status graph image for a load balancer service.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_Service/getGraphImage/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_Service::getGraphImage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LoadBalancer_Service::getGraphImage::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LoadBalancer_Service::getGraphImage::Parameters::Input",
+ "properties": {
+ "graphType": {
+ "type": "string"
+ },
+ "metric": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_Service/{SoftLayer_Network_LoadBalancer_ServiceID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Network_LoadBalancer_Service object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_LoadBalancer_Service service. You can only retrieve services on load balancers assigned to your account, and it is recommended that you simply retrieve the entire load balancer, as an individual service has no explicit purpose without its \"siblings\". ",
+ "summary": "Retrieve a SoftLayer_Network_LoadBalancer_Service record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_Service/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_Service::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_Service"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_Service/{SoftLayer_Network_LoadBalancer_ServiceID}/getStatus": {
+ "get": {
+ "description": "Returns an array of SoftLayer_Container_Network_LoadBalancer_StatusEntry objects. A SoftLayer_Container_Network_LoadBalancer_StatusEntry object has two variables, \"Label\" and \"Value\" \n\nCalling this function executes a command on the physical load balancer itself, and therefore should be called infrequently. For a general idea of the load balancer service, use the \"peakConnections\" variable on the Type \n\nPossible values for \"Label\" are: \n\n\n* IP Address\n* Port\n* Server Status\n* Load Status\n* Current Connections\n* Total Hits\n\n\nNot all labels are guaranteed to be returned. ",
+ "summary": "Returns various status entries for this service as an array of SoftLayer_Container_Network_LoadBalancer_StatusEntry objects",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_Service/getStatus/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_Service::getStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_LoadBalancer_StatusEntry"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_Service/{SoftLayer_Network_LoadBalancer_ServiceID}/resetPeakConnections": {
+ "get": {
+ "description": "Calling resetPeakConnections will set the peakConnections variable to zero on this particular object. Peak connections will continue to increase normally after this method call, it will only temporarily reset the statistic to zero, until the next time it is polled. ",
+ "summary": "Update the PeakConnections value on the service to zero.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_Service/resetPeakConnections/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_Service::resetPeakConnections",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_Service/{SoftLayer_Network_LoadBalancer_ServiceID}/getVip": {
+ "get": {
+ "description": "The load balancer that this service belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_Service/getVip/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_Service::getVip",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_ServiceID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_Service object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/disable": {
+ "get": {
+ "description": "Disable a Virtual IP Address, removing it from load balancer rotation and denying all connections to that IP address. ",
+ "summary": "Disable a Virtual IP Address",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/disable/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::disable",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/editObject": {
+ "post": {
+ "description": "Like any other API object, the load balancers can have their exposed properties edited by passing in a modified version of the object. The load balancer object also can modify its services in this way. Simply request the load balancer object you wish to edit, then modify the objects in the services array and pass the modified object to this function. WARNING: Services cannot be deleted in this manner, you must call deleteObject() on the service to physically remove them from the load balancer. ",
+ "summary": "Edit the object by passing in a modified instance of the object",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/editObject/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/enable": {
+ "get": {
+ "description": "Enable a disabled Virtual IP Address, allowing connections back to the IP address. ",
+ "summary": "Enable a Virtual IP Address",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/enable/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::enable",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Network_LoadBalancer_VirtualIpAddress object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_LoadBalancer_VirtualIpAddress service. You can only retrieve Load Balancers assigned to your account. ",
+ "summary": "Retrieve a SoftLayer_Network_LoadBalancer_VirtualIpAddress record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getObject/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_VirtualIpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/kickAllConnections": {
+ "get": {
+ "description": "Quickly remove all active external connections to a Virtual IP Address. ",
+ "summary": "Kick all active connections off a Virtual IP Address.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/kickAllConnections/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::kickAllConnections",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/upgradeConnectionLimit": {
+ "get": {
+ "description": "Upgrades the connection limit on the VirtualIp and changes the billing item on your account to reflect the change. This function will only upgrade you to the next \"level\" of service. The next level follows this pattern Current Level => Next Level 50 100 100 200 200 500 500 1000 1000 1200 1200 1500 1500 2000 2000 2500 2500 3000 ",
+ "summary": "Upgrades the connection limit on the Virtual IP Address and changes the billing item on your account to reflect the change.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::upgradeConnectionLimit",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/getAccount": {
+ "get": {
+ "description": "The account that owns this load balancer.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/getBillingItem": {
+ "get": {
+ "description": "The current billing item for the Load Balancer.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/getCustomerManagedFlag": {
+ "get": {
+ "description": "If false, this VIP and associated services may be edited via the portal or the API. If true, you must configure this VIP manually on the device.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getCustomerManagedFlag/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::getCustomerManagedFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/getManagedResourceFlag": {
+ "get": {
+ "description": "A flag indicating that the load balancer is a managed resource.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getManagedResourceFlag/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::getManagedResourceFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/getServices": {
+ "get": {
+ "description": "the services on this load balancer.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getServices/"
+ },
+ "operationId": "SoftLayer_Network_LoadBalancer_VirtualIpAddress::getServices",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_LoadBalancer_Service"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_LoadBalancer_VirtualIpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_LoadBalancer_VirtualIpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Message_Delivery"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_DeliveryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Message_Delivery record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Message_Delivery"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_DeliveryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/getUpgradeItemPrices": {
+ "get": {
+ "description": "Retrieve a list of upgradable items available for network message delivery. ",
+ "summary": "Retrieve available upgrade prices",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery/getUpgradeItemPrices/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery::getUpgradeItemPrices",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_DeliveryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/getAccount": {
+ "get": {
+ "description": "The SoftLayer customer account that a network message delivery account belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_DeliveryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/getBillingItem": {
+ "get": {
+ "description": "The billing item for a network message delivery account.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_DeliveryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/getType": {
+ "get": {
+ "description": "The message delivery type of a network message delivery account.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery/getType/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery::getType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Message_Delivery_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_DeliveryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/getVendor": {
+ "get": {
+ "description": "The vendor for a network message delivery account.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery/getVendor/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery::getVendor",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Message_Delivery_Vendor"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_DeliveryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/addUnsubscribeEmailAddress": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/addUnsubscribeEmailAddress/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::addUnsubscribeEmailAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::addUnsubscribeEmailAddress::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::addUnsubscribeEmailAddress::Parameters::Input",
+ "properties": {
+ "emailAddress": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/deleteEmailListEntries": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/deleteEmailListEntries/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::deleteEmailListEntries",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::deleteEmailListEntries::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::deleteEmailListEntries::Parameters::Input",
+ "properties": {
+ "list": {
+ "type": "string"
+ },
+ "entries": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/disableSmtpAccess": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/disableSmtpAccess/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::disableSmtpAccess",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::disableSmtpAccess::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::disableSmtpAccess::Parameters::Input",
+ "properties": {
+ "disable": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/enableSmtpAccess": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/enableSmtpAccess/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::enableSmtpAccess",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::enableSmtpAccess::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::enableSmtpAccess::Parameters::Input",
+ "properties": {
+ "enable": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getAccountOverview": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccountOverview/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getAccountOverview",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getEmailList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailList/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getEmailList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_List_Entry"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getEmailList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getEmailList::Parameters::Input",
+ "properties": {
+ "list": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Message_Delivery_Email_Sendgrid record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Message_Delivery_Email_Sendgrid"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getOfferingsList": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getOfferingsList/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getOfferingsList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getStatistics": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatistics/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getStatistics",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getStatistics::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getStatistics::Parameters::Input",
+ "properties": {
+ "options": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getStatisticsGraph": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatisticsGraph/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getStatisticsGraph",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Graph"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getStatisticsGraph::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getStatisticsGraph::Parameters::Input",
+ "properties": {
+ "options": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/singleSignOn": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/singleSignOn/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::singleSignOn",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/updateEmailAddress": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/updateEmailAddress/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::updateEmailAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::updateEmailAddress::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::updateEmailAddress::Parameters::Input",
+ "properties": {
+ "emailAddress": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Message_Delivery"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getUpgradeItemPrices": {
+ "get": {
+ "description": "Retrieve a list of upgradable items available for network message delivery. ",
+ "summary": "Retrieve available upgrade prices",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getUpgradeItemPrices/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getUpgradeItemPrices",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getEmailAddress": {
+ "get": {
+ "description": "The contact e-mail address used by SendGrid.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailAddress/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getEmailAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getSmtpAccess": {
+ "get": {
+ "description": "A flag that determines if a SendGrid e-mail delivery account has access to send mail through the SendGrid SMTP server.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getSmtpAccess/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getSmtpAccess",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getAccount": {
+ "get": {
+ "description": "The SoftLayer customer account that a network message delivery account belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getBillingItem": {
+ "get": {
+ "description": "The billing item for a network message delivery account.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getType": {
+ "get": {
+ "description": "The message delivery type of a network message delivery account.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getType/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Message_Delivery_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getVendor": {
+ "get": {
+ "description": "The vendor for a network message delivery account.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendor/"
+ },
+ "operationId": "SoftLayer_Network_Message_Delivery_Email_Sendgrid::getVendor",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Message_Delivery_Vendor"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Message_Delivery_Email_SendgridID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Message_Delivery_Email_Sendgrid object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor/getIpAddressesByHardware": {
+ "post": {
+ "description": "This will return an arrayObject of objects containing the ipaddresses. Using an string parameter you can send a partial ipaddress to search within a given ipaddress. You can also set the max limit as well using the setting the resultLimit. ",
+ "summary": "Returns an ArrayObject of subnet ip address objects for a hardware",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor/getIpAddressesByHardware/"
+ },
+ "operationId": "SoftLayer_Network_Monitor::getIpAddressesByHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor::getIpAddressesByHardware::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor::getIpAddressesByHardware::Parameters::Input",
+ "properties": {
+ "hardware": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ },
+ "partialIpAddress": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Monitor/getIpAddressesByVirtualGuest": {
+ "post": {
+ "description": "This will return an arrayObject of objects containing the ipaddresses. Using an string parameter you can send a partial ipaddress to search within a given ipaddress. You can also set the max limit as well using the setting the resultLimit. ",
+ "summary": "Returns an ArrayObject of subnet ip address objects for a guest resource.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor/getIpAddressesByVirtualGuest/"
+ },
+ "operationId": "SoftLayer_Network_Monitor::getIpAddressesByVirtualGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor::getIpAddressesByVirtualGuest::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor::getIpAddressesByVirtualGuest::Parameters::Input",
+ "properties": {
+ "guest": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ },
+ "partialIpAddress": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/createObject": {
+ "post": {
+ "description": "Passing in an unsaved instances of a Query_Host object into this function will create the object and return the results to the user. ",
+ "summary": "Create a monitoring entry",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/createObjects": {
+ "post": {
+ "description": "Passing in a collection of unsaved instances of Query_Host objects into this function will create all objects and return the results to the user. ",
+ "summary": "Create multiple monitoring entries at once",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObjects/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::createObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::createObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::createObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/{SoftLayer_Network_Monitor_Version1_Query_HostID}/deleteObject": {
+ "get": {
+ "description": "Like any other API object, the monitoring objects can be deleted by passing an instance of them into this function. The ID on the object must be set. ",
+ "summary": "Delete a Query_Host object by passing in a version of it",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Monitor_Version1_Query_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Monitor_Version1_Query_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObjects": {
+ "post": {
+ "description": "Like any other API object, the monitoring objects can be deleted by passing an instance of them into this function. The ID on the object must be set. ",
+ "summary": "Delete a group of Query_Host objects by passing in a collection of them",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObjects/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::deleteObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::deleteObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::deleteObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/{SoftLayer_Network_Monitor_Version1_Query_HostID}/editObject": {
+ "post": {
+ "description": "Like any other API object, the monitoring objects can have their exposed properties edited by passing in a modified version of the object. ",
+ "summary": "Edit the object by passing in a modified instance of the object",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Monitor_Version1_Query_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Monitor_Version1_Query_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/editObjects": {
+ "post": {
+ "description": "Like any other API object, the monitoring objects can have their exposed properties edited by passing in a modified version of the object. ",
+ "summary": "Edit a group of Query_Host objects by passing in a collection of them.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObjects/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::editObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::editObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::editObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/findByHardwareId": {
+ "post": {
+ "description": "This method returns all Query_Host objects associated with the passed in hardware ID as long as that hardware ID is owned by the current user's account. \n\nThis behavior can also be accomplished by simply tapping networkMonitors on the Hardware_Server object. ",
+ "summary": "Return all monitoring instances associated with the passed hardware ID",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/findByHardwareId/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::findByHardwareId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::findByHardwareId::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Monitor_Version1_Query_Host::findByHardwareId::Parameters::Input",
+ "properties": {
+ "hardwareId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/{SoftLayer_Network_Monitor_Version1_Query_HostID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Network_Monitor_Version1_Query_Host object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Monitor_Version1_Query_Host service. You can only retrieve query hosts attached to hardware that belong to your account. ",
+ "summary": "Retrieve a SoftLayer_Network_Monitor_Version1_Query_Host record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Monitor_Version1_Query_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Monitor_Version1_Query_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/{SoftLayer_Network_Monitor_Version1_Query_HostID}/getHardware": {
+ "get": {
+ "description": "The hardware that is being monitored by this monitoring instance",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getHardware/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::getHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Monitor_Version1_Query_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Monitor_Version1_Query_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/{SoftLayer_Network_Monitor_Version1_Query_HostID}/getLastResult": {
+ "get": {
+ "description": "The most recent result for this particular monitoring instance.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getLastResult/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::getLastResult",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Result"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Monitor_Version1_Query_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Monitor_Version1_Query_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/{SoftLayer_Network_Monitor_Version1_Query_HostID}/getQueryType": {
+ "get": {
+ "description": "The type of monitoring query that is executed when this hardware is monitored.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getQueryType/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::getQueryType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Monitor_Version1_Query_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Monitor_Version1_Query_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host/{SoftLayer_Network_Monitor_Version1_Query_HostID}/getResponseAction": {
+ "get": {
+ "description": "The action taken when a monitor fails.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getResponseAction/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host::getResponseAction",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_ResponseType"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Monitor_Version1_Query_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Monitor_Version1_Query_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllQueryTypes": {
+ "get": {
+ "description": "Calling this function returns all possible query type objects. These objects are to be used to set the values on the SoftLayer_Network_Monitor_Version1_Query_Host when creating new monitoring instances. ",
+ "summary": "Return all Query_Type objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllQueryTypes/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host_Stratum::getAllQueryTypes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Type"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllResponseTypes": {
+ "get": {
+ "description": "Calling this function returns all possible response type objects. These objects are to be used to set the values on the SoftLayer_Network_Monitor_Version1_Query_Host when creating new monitoring instances. ",
+ "summary": "Return all ResponseType objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllResponseTypes/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host_Stratum::getAllResponseTypes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_ResponseType"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/{SoftLayer_Network_Monitor_Version1_Query_Host_StratumID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Network_Monitor_Version1_Query_Host_Stratum object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Monitor_Version1_Query_Host_Stratum service. You can only retrieve strata attached to hardware that belong to your account. ",
+ "summary": "Retrieve a SoftLayer_Network_Monitor_Version1_Query_Host_Stratum record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host_Stratum::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Monitor_Version1_Query_Host_StratumID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Monitor_Version1_Query_Host_Stratum object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/{SoftLayer_Network_Monitor_Version1_Query_Host_StratumID}/getHardware": {
+ "get": {
+ "description": "The hardware object that these monitoring permissions applies to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getHardware/"
+ },
+ "operationId": "SoftLayer_Network_Monitor_Version1_Query_Host_Stratum::getHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Monitor_Version1_Query_Host_StratumID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Monitor_Version1_Query_Host_Stratum object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Pod/getAllObjects": {
+ "get": {
+ "description": "Filtering is supported for ``datacenterName`` and ``capabilities``. When filtering on capabilities, use the ``in`` operation. Pods fulfilling all capabilities provided will be returned. ``datacenterName`` represents an operation against ``SoftLayer_Location_Datacenter.name`, such as dal05 when referring to Dallas 5. \n\n```Examples:``` \n\nList Pods in a specific datacenter. datacenterName.operation = 'dal06'\n\nList Pods in a geographical area.
datacenterName.operation = '^= dal'\n\nList Pods in a region fulfilling capabilities.
datacenterName.operation = '^= dal' capabilities.operation = 'in' capabilities.options = [ { name = data, value = [SOME_CAPABILITY, ANOTHER_CAPABILITY] } ] ",
+ "summary": "Retrieve a list of Pods; optionally filtered via datacenter and/or capabilities.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Pod/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Pod::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Pod"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Pod/{SoftLayer_Network_PodID}/getCapabilities": {
+ "get": {
+ "description": "Provides the list of capabilities a Pod fulfills. See [[SoftLayer_Network_Pod/listCapabilities]] for more information on capabilities. ",
+ "summary": "Retrieve capabilities for the Pod.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Pod/getCapabilities/"
+ },
+ "operationId": "SoftLayer_Network_Pod::getCapabilities",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_PodID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Pod object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Pod/{SoftLayer_Network_PodID}/getObject": {
+ "get": {
+ "description": "Set the initialization parameter to the ``name`` of the Pod to retrieve. ",
+ "summary": "Retrieve a Pod by name.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Pod/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Pod::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Pod"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_PodID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Pod object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Pod/listCapabilities": {
+ "get": {
+ "description": "A capability is simply a string literal that denotes the availability of a feature. Capabilities are generally self describing, but any additional details concerning the implications of a capability will be documented elsewhere; usually by the Service or Operation related to it. ",
+ "summary": "Retrieve a list of all possible capabilities Pods may fulfill.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Pod/listCapabilities/"
+ },
+ "operationId": "SoftLayer_Network_Pod::listCapabilities",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Security_Scanner_Request/createObject": {
+ "post": {
+ "description": "Create a new vulnerability scan request. New scan requests are picked up every five minutes, and the time to complete an actual scan may vary. Once the scan is finished, it can take up to another five minutes for the report to be generated and accessible. ",
+ "summary": "Create a new vulnerability scan request.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Security_Scanner_Request/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Security_Scanner_Request::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Security_Scanner_Request"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Security_Scanner_Request::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Security_Scanner_Request::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Security_Scanner_Request"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Network_Security_Scanner_Request object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Security_Scanner_Request service. You can only retrieve requests and reports that are assigned to your SoftLayer account. ",
+ "summary": "Retrieve a SoftLayer_Network_Security_Scanner_Request record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Security_Scanner_Request/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Security_Scanner_Request::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Security_Scanner_Request"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Security_Scanner_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Security_Scanner_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getReport": {
+ "get": {
+ "description": "Get the vulnerability report for a scan request, formatted as HTML string. Previous scan reports are held indefinitely. ",
+ "summary": "Get the vulnerability report for a scan request.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Security_Scanner_Request/getReport/"
+ },
+ "operationId": "SoftLayer_Network_Security_Scanner_Request::getReport",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Security_Scanner_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Security_Scanner_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getAccount": {
+ "get": {
+ "description": "The account associated with a security scan request.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Security_Scanner_Request/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Security_Scanner_Request::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Security_Scanner_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Security_Scanner_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getGuest": {
+ "get": {
+ "description": "The virtual guest a security scan is run against.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Security_Scanner_Request/getGuest/"
+ },
+ "operationId": "SoftLayer_Network_Security_Scanner_Request::getGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Security_Scanner_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Security_Scanner_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getHardware": {
+ "get": {
+ "description": "The hardware a security scan is run against.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Security_Scanner_Request/getHardware/"
+ },
+ "operationId": "SoftLayer_Network_Security_Scanner_Request::getHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Security_Scanner_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Security_Scanner_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getRequestorOwnedFlag": {
+ "get": {
+ "description": "Flag whether the requestor owns the hardware the scan was run on. This flag will return for hardware servers only, virtual servers will result in a null return even if you have a request out for them.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Security_Scanner_Request/getRequestorOwnedFlag/"
+ },
+ "operationId": "SoftLayer_Network_Security_Scanner_Request::getRequestorOwnedFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Security_Scanner_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Security_Scanner_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getStatus": {
+ "get": {
+ "description": "A security scan request's status.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Security_Scanner_Request/getStatus/"
+ },
+ "operationId": "SoftLayer_Network_Security_Scanner_Request::getStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Security_Scanner_Request_Status"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Security_Scanner_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Security_Scanner_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/addRules": {
+ "post": {
+ "description": "Add new rules to a security group by sending in an array of template [[SoftLayer_Network_SecurityGroup_Rule (type)]] objects to be created. ",
+ "summary": "Add new rules to a security group.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/addRules/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::addRules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup_RequestRules"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::addRules::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::addRules::Parameters::Input",
+ "properties": {
+ "ruleTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup_Rule"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/attachNetworkComponents": {
+ "post": {
+ "description": "Attach virtual guest network components to a security group by creating [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]] objects. ",
+ "summary": "Attach network components to a security group by creating a network component binding. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/attachNetworkComponents/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::attachNetworkComponents",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup_Request"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::attachNetworkComponents::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::attachNetworkComponents::Parameters::Input",
+ "properties": {
+ "networkComponentIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/createObject": {
+ "post": {
+ "description": "Create a new security group.",
+ "summary": "Create a new security group.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/createObject/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/createObjects": {
+ "post": {
+ "description": "Create new security groups.",
+ "summary": "Create new security groups.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/createObjects/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::createObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::createObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::createObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/deleteObject": {
+ "get": {
+ "description": "Delete a security group for an account. A security group cannot be deleted if any network components are attached or if the security group is a remote security group for a [[SoftLayer_Network_SecurityGroup_Rule (type)|rule]]. ",
+ "summary": "Delete a security group.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/deleteObjects": {
+ "post": {
+ "description": "Delete security groups for an account. A security group cannot be deleted if any network components are attached or if the security group is a remote security group for a [[SoftLayer_Network_SecurityGroup_Rule (type)|rule]]. ",
+ "summary": "Delete security groups.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/deleteObjects/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::deleteObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::deleteObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::deleteObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/detachNetworkComponents": {
+ "post": {
+ "description": "Detach virtual guest network components from a security group by deleting its [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]]. ",
+ "summary": "Detach network components from a security group by deleting its network component binding. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/detachNetworkComponents/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::detachNetworkComponents",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup_Request"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::detachNetworkComponents::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::detachNetworkComponents::Parameters::Input",
+ "properties": {
+ "networkComponentIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/editObject": {
+ "post": {
+ "description": "Edit a security group.",
+ "summary": "Edit a security group.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/editObject/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/editObjects": {
+ "post": {
+ "description": "Edit security groups.",
+ "summary": "Edit security groups.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/editObjects/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::editObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::editObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::editObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/editRules": {
+ "post": {
+ "description": "Edit rules that belong to the security group. An array of skeleton [[SoftLayer_Network_SecurityGroup_Rule]] objects must be sent in with only the properties defined that you want to change. To edit a property to null, send in -1 for integer properties and \"\" for string properties. Unchanged properties are left alone. ",
+ "summary": "Edit rules that belong to a security group.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/editRules/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::editRules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup_RequestRules"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::editRules::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::editRules::Parameters::Input",
+ "properties": {
+ "ruleTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup_Rule"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "Get all security groups.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/getLimits": {
+ "get": {
+ "description": "List the current security group limits ",
+ "summary": "List the current security group limits ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/getLimits/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::getLimits",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_SecurityGroup_Limit"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_SecurityGroup record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/getObject/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/getSupportedDataCenters": {
+ "get": {
+ "description": "List the data centers that currently support the use of security groups. ",
+ "summary": "List the data centers that currently support the use of security groups. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/getSupportedDataCenters/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::getSupportedDataCenters",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Location"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/removeRules": {
+ "post": {
+ "description": "Remove rules from a security group.",
+ "summary": "Remove rules from a security group.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/removeRules/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::removeRules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup_RequestRules"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::removeRules::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_SecurityGroup::removeRules::Parameters::Input",
+ "properties": {
+ "ruleIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/getAccount": {
+ "get": {
+ "description": "The account this security group belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/getNetworkComponentBindings": {
+ "get": {
+ "description": "The network component bindings for this security group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/getNetworkComponentBindings/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::getNetworkComponentBindings",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/getOrderBindings": {
+ "get": {
+ "description": "The order bindings for this security group",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/getOrderBindings/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::getOrderBindings",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup_OrderBinding"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/getRules": {
+ "get": {
+ "description": "The rules for this security group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_SecurityGroup/getRules/"
+ },
+ "operationId": "SoftLayer_Network_SecurityGroup::getRules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_SecurityGroup_Rule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_SecurityGroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_SecurityGroup object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Service_Vpn_Overrides/createObjects": {
+ "post": {
+ "description": "Create Softlayer portal user VPN overrides. ",
+ "summary": "Create Softlayer portal user VPN overrides.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Service_Vpn_Overrides/createObjects/"
+ },
+ "operationId": "SoftLayer_Network_Service_Vpn_Overrides::createObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Service_Vpn_Overrides::createObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Service_Vpn_Overrides::createObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Vpn_Overrides"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Service_Vpn_Overrides/{SoftLayer_Network_Service_Vpn_OverridesID}/deleteObject": {
+ "get": {
+ "description": "Use this method to delete a single SoftLayer portal VPN user subnet override. ",
+ "summary": "Delete single override.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Service_Vpn_Overrides::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Service_Vpn_OverridesID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Service_Vpn_Overrides object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Service_Vpn_Overrides/deleteObjects": {
+ "post": {
+ "description": "Use this method to delete a collection of SoftLayer portal VPN user subnet overrides. ",
+ "summary": "Delete multiple entries in the overrides 'white list' for a SoftLayer portal VPN user.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObjects/"
+ },
+ "operationId": "SoftLayer_Network_Service_Vpn_Overrides::deleteObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Service_Vpn_Overrides::deleteObjects::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Service_Vpn_Overrides::deleteObjects::Parameters::Input",
+ "properties": {
+ "templateObjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Vpn_Overrides"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Service_Vpn_Overrides/{SoftLayer_Network_Service_Vpn_OverridesID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Service_Vpn_Overrides record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Service_Vpn_Overrides::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Vpn_Overrides"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Service_Vpn_OverridesID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Service_Vpn_Overrides object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Service_Vpn_Overrides/{SoftLayer_Network_Service_Vpn_OverridesID}/getSubnet": {
+ "get": {
+ "description": "Subnet components accessible by a SoftLayer VPN portal user.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Service_Vpn_Overrides::getSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Service_Vpn_OverridesID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Service_Vpn_Overrides object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Service_Vpn_Overrides/{SoftLayer_Network_Service_Vpn_OverridesID}/getUser": {
+ "get": {
+ "description": "SoftLayer VPN portal user.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getUser/"
+ },
+ "operationId": "SoftLayer_Network_Service_Vpn_Overrides::getUser",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_User_Customer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Service_Vpn_OverridesID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Service_Vpn_Overrides object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromHardware": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. ",
+ "summary": "Allow access to this volume from a specified SoftLayer_Hardware object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessFromHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessFromHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromHardware::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromHardware::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromHardwareList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessFromHardwareList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessFromHardwareList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromHardwareList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromHardwareList::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromHost": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. ",
+ "summary": "Allow access to this volume from a specified [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessFromHost/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessFromHost",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromHost::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromHost::Parameters::Input",
+ "properties": {
+ "typeClassName": {
+ "type": "string"
+ },
+ "hostId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromHostList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage volume will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. ",
+ "summary": "Allow access to this volume from multiple [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessFromHostList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessFromHostList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromHostList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromHostList::Parameters::Input",
+ "properties": {
+ "hostObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromIpAddress": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume. ",
+ "summary": "Allow access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessFromIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromIpAddress::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromIpAddress::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromIpAddressList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddressList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessFromIpAddressList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromIpAddressList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromIpAddressList::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromSubnet": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. ",
+ "summary": "Allow access to this volume from multiple SoftLayer_Network_Subnet objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessFromSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromSubnet::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromSubnet::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromSubnetList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnetList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessFromSubnetList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromSubnetList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromSubnetList::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromVirtualGuest": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. ",
+ "summary": "Allow access to this volume from a specified SoftLayer_Virtual_Guest object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuest/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessFromVirtualGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromVirtualGuest::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromVirtualGuest::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromVirtualGuestList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. ",
+ "summary": "Allow access to this volume from multiple SoftLayer_Virtual_Guest objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuestList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessFromVirtualGuestList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromVirtualGuestList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessFromVirtualGuestList::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessToReplicantFromHardware": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume. ",
+ "summary": "Allow access to this replicant volume from a specified SoftLayer_Hardware object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessToReplicantFromHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromHardware::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromHardware::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessToReplicantFromHardwareList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume. ",
+ "summary": "allow access to this volume's replica from multiple SoftLayer_Hardware objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardwareList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessToReplicantFromHardwareList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromHardwareList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromHardwareList::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessToReplicantFromIpAddress": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessToReplicantFromIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromIpAddress::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromIpAddress::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessToReplicantFromIpAddressList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume. ",
+ "summary": "allow access to this volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddressList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessToReplicantFromIpAddressList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromIpAddressList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromIpAddressList::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessToReplicantFromSubnet": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume. ",
+ "summary": "Allow access to this replicant volume from multiple SoftLayer_Network_Subnet objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessToReplicantFromSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromSubnet::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromSubnet::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessToReplicantFromSubnetList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume. ",
+ "summary": "allow access to this volume's replica from multiple SoftLayer_Network_Subnet objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnetList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessToReplicantFromSubnetList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromSubnetList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromSubnetList::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessToReplicantFromVirtualGuest": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replicant volume. ",
+ "summary": "Allow access to this replicant volume from a specified SoftLayer_Virtual_Guest object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuest/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessToReplicantFromVirtualGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromVirtualGuest::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromVirtualGuest::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessToReplicantFromVirtualGuestList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume. ",
+ "summary": "allow access to this volume's replica from multiple SoftLayer_Virtual_Guest objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuestList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::allowAccessToReplicantFromVirtualGuestList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromVirtualGuestList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::allowAccessToReplicantFromVirtualGuestList::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/assignCredential": {
+ "post": {
+ "description": "This method will assign an existing credential to the current volume. The credential must have been created using the 'addNewCredential' method. The volume type must support an additional credential. ",
+ "summary": "This method will assign an existing credential to the current volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/assignCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage::assignCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::assignCredential::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::assignCredential::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/assignNewCredential": {
+ "post": {
+ "description": "This method will set up a new credential for the remote storage volume. The storage volume must support an additional credential. Once created, the credential will be automatically assigned to the current volume. If there are no volumes assigned to the credential it will be automatically deleted. ",
+ "summary": "This method will set up a new credential for the remote storage volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/assignNewCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage::assignNewCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::assignNewCredential::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::assignNewCredential::Parameters::Input",
+ "properties": {
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/changePassword": {
+ "post": {
+ "description": "The method will change the password for the given Storage/Virtual Server Storage account. ",
+ "summary": "Change the password for a Storage/Virtual Server Storage account",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/changePassword/"
+ },
+ "operationId": "SoftLayer_Network_Storage::changePassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::changePassword::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::changePassword::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ },
+ "currentPassword": {
+ "type": "string"
+ },
+ "newPassword": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/collectBandwidth": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} \n\ncollectBandwidth() Retrieve the bandwidth usage for the current billing cycle. ",
+ "summary": "Retrieve the bandwidth usage for the current billing cycle.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/collectBandwidth/"
+ },
+ "operationId": "SoftLayer_Network_Storage::collectBandwidth",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::collectBandwidth::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::collectBandwidth::Parameters::Input",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "startDate": {
+ "type": "string"
+ },
+ "endDate": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/collectBytesUsed": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} \n\ncollectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account. ",
+ "summary": "Retrieve the number of bytes capacity currently in use on a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/collectBytesUsed/"
+ },
+ "operationId": "SoftLayer_Network_Storage::collectBytesUsed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/convertCloneDependentToIndependent": {
+ "get": {
+ "description": null,
+ "summary": "Splits a clone from its parent allowing it to be an independent volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/convertCloneDependentToIndependent/"
+ },
+ "operationId": "SoftLayer_Network_Storage::convertCloneDependentToIndependent",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/createFolder": {
+ "post": {
+ "description": null,
+ "summary": "Create a new folder in the root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/createFolder/"
+ },
+ "operationId": "SoftLayer_Network_Storage::createFolder",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::createFolder::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::createFolder::Parameters::Input",
+ "properties": {
+ "folder": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/createOrUpdateLunId": {
+ "post": {
+ "description": "The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method. ",
+ "summary": "Creates or updates the LUN ID property on a volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/createOrUpdateLunId/"
+ },
+ "operationId": "SoftLayer_Network_Storage::createOrUpdateLunId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Property"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::createOrUpdateLunId::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::createOrUpdateLunId::Parameters::Input",
+ "properties": {
+ "lunId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/createSnapshot": {
+ "post": {
+ "description": null,
+ "summary": "Manually create a new snapshot of a storage volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/createSnapshot/"
+ },
+ "operationId": "SoftLayer_Network_Storage::createSnapshot",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::createSnapshot::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::createSnapshot::Parameters::Input",
+ "properties": {
+ "notes": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/deleteAllFiles": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} Delete all files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin. \n\nCurrently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted. \n\nPlease note, files can not be restored once they are permanently deleted. ",
+ "summary": "Delete all files within a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/deleteAllFiles/"
+ },
+ "operationId": "SoftLayer_Network_Storage::deleteAllFiles",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/deleteFile": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account's recycle bin. \n\nCurrently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account's recycle bin. If the file exist in the recycle bin, then it is permanently deleted. \n\nPlease note, a file can not be restored once it is permanently deleted. ",
+ "summary": "Delete an individual file within a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/deleteFile/"
+ },
+ "operationId": "SoftLayer_Network_Storage::deleteFile",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::deleteFile::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::deleteFile::Parameters::Input",
+ "properties": {
+ "fileId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/deleteFiles": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Delete multiple files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin. \n\nCurrently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted. \n\nPlease note, files can not be restored once they are permanently deleted. ",
+ "summary": "Delete multiple files within a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/deleteFiles/"
+ },
+ "operationId": "SoftLayer_Network_Storage::deleteFiles",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::deleteFiles::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::deleteFiles::Parameters::Input",
+ "properties": {
+ "fileIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/deleteFolder": {
+ "post": {
+ "description": null,
+ "summary": "Delete a folder in the root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/deleteFolder/"
+ },
+ "operationId": "SoftLayer_Network_Storage::deleteFolder",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::deleteFolder::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::deleteFolder::Parameters::Input",
+ "properties": {
+ "folder": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/deleteObject": {
+ "get": {
+ "description": "Delete a network storage volume. '''This cannot be undone.''' At this time only network storage snapshots may be deleted with this method. \n\n''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a volume; ",
+ "summary": "Delete a network storage volume",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/disableSnapshots": {
+ "post": {
+ "description": "This method is not valid for Legacy iSCSI Storage Volumes. \n\nDisable scheduled snapshots of this storage volume. Scheduling options include 'INTERVAL', HOURLY, DAILY and WEEKLY schedules. ",
+ "summary": "Disable snapshots of this Storage Volume on a schedule.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/disableSnapshots/"
+ },
+ "operationId": "SoftLayer_Network_Storage::disableSnapshots",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::disableSnapshots::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::disableSnapshots::Parameters::Input",
+ "properties": {
+ "scheduleType": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/disasterRecoveryFailoverToReplicant": {
+ "post": {
+ "description": "If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately failover to an available replica in another location. This method does not allow for fail back via the API. To fail back to the original volume after using this method, open a support ticket. To test failover, use [[SoftLayer_Network_Storage::failoverToReplicant]] instead. ",
+ "summary": "Failover an inaccessible block/file volume to its available replicant volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/disasterRecoveryFailoverToReplicant/"
+ },
+ "operationId": "SoftLayer_Network_Storage::disasterRecoveryFailoverToReplicant",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::disasterRecoveryFailoverToReplicant::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::disasterRecoveryFailoverToReplicant::Parameters::Input",
+ "properties": {
+ "replicantId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/downloadFile": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Download a file from a Storage account. This method returns a file's details including the file's raw content. ",
+ "summary": "Download a file from a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/downloadFile/"
+ },
+ "operationId": "SoftLayer_Network_Storage::downloadFile",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::downloadFile::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::downloadFile::Parameters::Input",
+ "properties": {
+ "fileId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/editCredential": {
+ "post": {
+ "description": "This method will change the password of a credential created using the 'addNewCredential' method. If the credential exists on multiple storage volumes it will change for those volumes as well. ",
+ "summary": "This method will change the password of a credential created using the 'addNewCredential' method.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/editCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage::editCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::editCredential::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::editCredential::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ },
+ "newPassword": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/editObject": {
+ "post": {
+ "description": "The password and/or notes may be modified for the Storage service except evault passwords and notes. ",
+ "summary": "Edit the password and/or notes for the Storage service",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/enableSnapshots": {
+ "post": {
+ "description": "This method is not valid for Legacy iSCSI Storage Volumes. \n\nEnable scheduled snapshots of this storage volume. Scheduling options include HOURLY, DAILY and WEEKLY schedules. For HOURLY schedules, provide relevant data for $scheduleType, $retentionCount and $minute. For DAILY schedules, provide relevant data for $scheduleType, $retentionCount, $minute, and $hour. For WEEKLY schedules, provide relevant data for all parameters of this method. ",
+ "summary": "Enable snapshots of this Storage Volume on a schedule.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/enableSnapshots/"
+ },
+ "operationId": "SoftLayer_Network_Storage::enableSnapshots",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::enableSnapshots::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::enableSnapshots::Parameters::Input",
+ "properties": {
+ "scheduleType": {
+ "type": "string"
+ },
+ "retentionCount": {
+ "type": "number"
+ },
+ "minute": {
+ "type": "number"
+ },
+ "hour": {
+ "type": "number"
+ },
+ "dayOfWeek": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/failbackFromReplicant": {
+ "get": {
+ "description": "Failback from a volume replicant. In order to failback the volume must have already been failed over to a replicant. ",
+ "summary": "Failback from a volume replicant.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/failbackFromReplicant/"
+ },
+ "operationId": "SoftLayer_Network_Storage::failbackFromReplicant",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/failoverToReplicant": {
+ "post": {
+ "description": "Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available. ",
+ "summary": "Failover to a volume replicant.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/failoverToReplicant/"
+ },
+ "operationId": "SoftLayer_Network_Storage::failoverToReplicant",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::failoverToReplicant::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::failoverToReplicant::Parameters::Input",
+ "properties": {
+ "replicantId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllFiles": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory. This does not download file content. ",
+ "summary": "Retrieve a listing of all files in a Storage account's root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllFiles/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllFiles",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllFilesByFilter": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory. This does not download file content. ",
+ "summary": "Retrieve a listing of all files matching the filter's criteria in a Storage account's root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllFilesByFilter/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllFilesByFilter",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getAllFilesByFilter::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getAllFilesByFilter::Parameters::Input",
+ "properties": {
+ "filter": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowableHardware": {
+ "post": {
+ "description": "This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage. ",
+ "summary": "Return a list of SoftLayer_Hardware that can be authorized to this volume. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowableHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowableHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getAllowableHardware::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getAllowableHardware::Parameters::Input",
+ "properties": {
+ "filterHostname": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowableIpAddresses": {
+ "post": {
+ "description": "This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage. ",
+ "summary": "Return a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this volume. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowableIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowableIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getAllowableIpAddresses::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getAllowableIpAddresses::Parameters::Input",
+ "properties": {
+ "subnetId": {
+ "type": "number"
+ },
+ "filterIpAddress": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowableSubnets": {
+ "post": {
+ "description": "This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage. ",
+ "summary": "Return a list of SoftLayer_Network_Subnet that can be authorized to this volume. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowableSubnets/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowableSubnets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getAllowableSubnets::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getAllowableSubnets::Parameters::Input",
+ "properties": {
+ "filterNetworkIdentifier": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowableVirtualGuests": {
+ "post": {
+ "description": "This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage. ",
+ "summary": "Return a list of SoftLayer_Virtual_Guest that can be authorized to this volume. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowableVirtualGuests/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowableVirtualGuests",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getAllowableVirtualGuests::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getAllowableVirtualGuests::Parameters::Input",
+ "properties": {
+ "filterHostname": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedHostsLimit": {
+ "get": {
+ "description": "Retrieves the total number of allowed hosts limit per volume. ",
+ "summary": "Retrieves the total number of allowed hosts limit per volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowedHostsLimit/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowedHostsLimit",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/getByUsername": {
+ "post": {
+ "description": "Retrieve network storage accounts by username and storage account type. Use this method if you wish to retrieve a storage record by username rather than by id. The ''type'' parameter must correspond to one of the available ''nasType'' values in the SoftLayer_Network_Storage data type. ",
+ "summary": "Retrieve network storage accounts by username. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getByUsername/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getByUsername",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getByUsername::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getByUsername::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getCdnUrls": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getCdnUrls/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getCdnUrls",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getClusterResource": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getClusterResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getClusterResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getDuplicateConversionStatus": {
+ "get": {
+ "description": "This method is used to check, if for the given classic file block storage volume, a transaction performing dependent to independent duplicate conversion is active. If yes, then this returns the current percentage of its progress along with its start time as [SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation] object with its name, percentage and transaction start timestamp. ",
+ "summary": "An API to fetch the percentage progress of conversion of a dependent",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getDuplicateConversionStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getDuplicateConversionStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/getFileBlockEncryptedLocations": {
+ "get": {
+ "description": "\n\n",
+ "summary": "Returns a list of SoftLayer_Location_Datacenter objects corresponding to Datacenters in which File and Block Storage Volumes with Encryption at Rest may be ordered. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFileBlockEncryptedLocations/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFileBlockEncryptedLocations",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Location"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFileByIdentifier": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date of a file within a Storage account. This does not download file content. ",
+ "summary": "Retrieve an individual file's details.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFileByIdentifier/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFileByIdentifier",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getFileByIdentifier::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getFileByIdentifier::Parameters::Input",
+ "properties": {
+ "identifier": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFileCount": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve the file number of files in a Virtual Server Storage account's root directory. This does not include the files stored in the recycle bin. ",
+ "summary": "Retrieve the file number of files in a Virtual Server Storage account's root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFileCount/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFileCount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFileList": {
+ "post": {
+ "description": null,
+ "summary": "Retrieve list of files in a given folder for this account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFileList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFileList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getFileList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getFileList::Parameters::Input",
+ "properties": {
+ "folder": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFilePendingDeleteCount": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve the number of files pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted. ",
+ "summary": "Retrieve the number of files pending deletion in a Storage account's recycle bin.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFilePendingDeleteCount/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFilePendingDeleteCount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFilesPendingDelete": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve a list of files that are pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted. This method does not download file content. ",
+ "summary": "Retrieve a list of files in a Storage account's recycle bin.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFilesPendingDelete/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFilesPendingDelete",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFolderList": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a list of level 1 folders for this account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFolderList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFolderList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Folder"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getGraph": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} \n\ngetGraph() 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. ",
+ "summary": "Retrieve a graph representing the bandwidth used by a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getGraph/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getGraph",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getGraph::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getGraph::Parameters::Input",
+ "properties": {
+ "startDate": {
+ "type": "string"
+ },
+ "endDate": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getMaximumExpansionSize": {
+ "get": {
+ "description": null,
+ "summary": "Returns the maximum volume expansion size in GB.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getMaximumExpansionSize/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getMaximumExpansionSize",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getNetworkConnectionDetails": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve network connection details for complex network storage volumes.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getNetworkConnectionDetails/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getNetworkConnectionDetails",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_NetworkConnectionInformation"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getNetworkMountAddress": {
+ "get": {
+ "description": null,
+ "summary": "Displays the mount path of a storage volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getNetworkMountAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getNetworkMountAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getNetworkMountPath": {
+ "get": {
+ "description": null,
+ "summary": "Displays the mount path of a storage volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getNetworkMountPath/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getNetworkMountPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Network_Storage object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Storage service. \n\nPlease use the associated methods in the [[SoftLayer_Network_Storage]] service to retrieve a Storage account's id. ",
+ "summary": "Retrieve a SoftLayer_Network_Storage record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/getObjectStorageConnectionInformation": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve all object storage details for connection",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getObjectStorageConnectionInformation/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getObjectStorageConnectionInformation",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Service_Resource_ObjectStorage_ConnectionInformation"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/getObjectsByCredential": {
+ "post": {
+ "description": "Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. Use this method if you wish to retrieve a storage record by a credential rather than by id. ",
+ "summary": "Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getObjectsByCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getObjectsByCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getObjectsByCredential::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getObjectsByCredential::Parameters::Input",
+ "properties": {
+ "credentialObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getRecycleBinFileByIdentifier": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve the details of a file that is pending deletion in a Storage account's a recycle bin. ",
+ "summary": "Retrieve all files that are in the recycle bin (pending delete). This method is only used for Virtual Server Storage accounts at moment but may expanded to other Storage types in the future.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getRecycleBinFileByIdentifier/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getRecycleBinFileByIdentifier",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getRecycleBinFileByIdentifier::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::getRecycleBinFileByIdentifier::Parameters::Input",
+ "properties": {
+ "fileId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getRemainingAllowedHosts": {
+ "get": {
+ "description": "Retrieves the remaining number of allowed hosts per volume. ",
+ "summary": "Retrieves the remaining number of allowed hosts per volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHosts/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getRemainingAllowedHosts",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getRemainingAllowedHostsForReplicant": {
+ "get": {
+ "description": "Retrieves the remaining number of allowed hosts for a volume's replicant. ",
+ "summary": "Retrieves the remaining number of allowed hosts for a volume's replicant.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHostsForReplicant/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getRemainingAllowedHostsForReplicant",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicationTimestamp": {
+ "get": {
+ "description": null,
+ "summary": "An API call to fetch the last timestamp of the replication process",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getReplicationTimestamp/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getReplicationTimestamp",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotsForVolume": {
+ "get": {
+ "description": "Retrieves a list of snapshots for this SoftLayer_Network_Storage volume. This method works with the result limits and offset to support pagination. ",
+ "summary": "Retrieves a list o\u0192f snapshots for a given volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getSnapshotsForVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getSnapshotsForVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getStorageGroupsNetworkConnectionDetails": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getStorageGroupsNetworkConnectionDetails/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getStorageGroupsNetworkConnectionDetails",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_NetworkConnectionInformation"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getTargetIpAddresses": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getTargetIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getTargetIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getValidReplicationTargetDatacenterLocations": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getValidReplicationTargetDatacenterLocations/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getValidReplicationTargetDatacenterLocations",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Location"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/getVolumeCountLimits": {
+ "get": {
+ "description": "Retrieves an array of volume count limits per location and globally. ",
+ "summary": "Retrieves an array of volume count limits per location and globally.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getVolumeCountLimits/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getVolumeCountLimits",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getVolumeDuplicateParameters": {
+ "get": {
+ "description": "This method returns the parameters for cloning a volume ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getVolumeDuplicateParameters/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getVolumeDuplicateParameters",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_VolumeDuplicateParameters"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/immediateFailoverToReplicant": {
+ "post": {
+ "description": "Immediate Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available. ",
+ "summary": "Immediate Failover to a volume replicant.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/immediateFailoverToReplicant/"
+ },
+ "operationId": "SoftLayer_Network_Storage::immediateFailoverToReplicant",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::immediateFailoverToReplicant::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::immediateFailoverToReplicant::Parameters::Input",
+ "properties": {
+ "replicantId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/initiateOriginVolumeReclaim": {
+ "get": {
+ "description": null,
+ "summary": "Initiates Origin Volume Reclaim to delete volume from NetApp.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/initiateOriginVolumeReclaim/"
+ },
+ "operationId": "SoftLayer_Network_Storage::initiateOriginVolumeReclaim",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/initiateVolumeCutover": {
+ "get": {
+ "description": null,
+ "summary": "Initiates Volume Cutover to remove access from the old volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/initiateVolumeCutover/"
+ },
+ "operationId": "SoftLayer_Network_Storage::initiateVolumeCutover",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/isBlockingOperationInProgress": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/isBlockingOperationInProgress/"
+ },
+ "operationId": "SoftLayer_Network_Storage::isBlockingOperationInProgress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::isBlockingOperationInProgress::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::isBlockingOperationInProgress::Parameters::Input",
+ "properties": {
+ "exemptStatusKeyNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/isDuplicateReadyForSnapshot": {
+ "get": {
+ "description": "This method returns a boolean indicating whether the clone volume is ready for snapshot. ",
+ "summary": "Displays the if clone snapshots can be ordered.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/isDuplicateReadyForSnapshot/"
+ },
+ "operationId": "SoftLayer_Network_Storage::isDuplicateReadyForSnapshot",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/isDuplicateReadyToMount": {
+ "get": {
+ "description": "This method returns a boolean indicating whether the clone volume is ready to mount. ",
+ "summary": "Displays the status of a clone mount.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/isDuplicateReadyToMount/"
+ },
+ "operationId": "SoftLayer_Network_Storage::isDuplicateReadyToMount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/isVolumeActive": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/isVolumeActive/"
+ },
+ "operationId": "SoftLayer_Network_Storage::isVolumeActive",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/refreshDependentDuplicate": {
+ "post": {
+ "description": null,
+ "summary": "Refreshes a duplicate volume with a snapshot taken from its parent. This is deprecated now.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/refreshDependentDuplicate/"
+ },
+ "operationId": "SoftLayer_Network_Storage::refreshDependentDuplicate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::refreshDependentDuplicate::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::refreshDependentDuplicate::Parameters::Input",
+ "properties": {
+ "snapshotId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/refreshDuplicate": {
+ "post": {
+ "description": null,
+ "summary": "Refreshes any duplicate volume with a snapshot taken from its parent.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/refreshDuplicate/"
+ },
+ "operationId": "SoftLayer_Network_Storage::refreshDuplicate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::refreshDuplicate::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::refreshDuplicate::Parameters::Input",
+ "properties": {
+ "snapshotId": {
+ "type": "number"
+ },
+ "forceRefresh": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromHardware": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. ",
+ "summary": "Remove access to this volume from a specified SoftLayer_Hardware object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessFromHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessFromHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromHardware::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromHardware::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromHardwareList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. ",
+ "summary": "Remove access to this volume from multiple SoftLayer_Hardware objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessFromHardwareList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessFromHardwareList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromHardwareList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromHardwareList::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromHost": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. ",
+ "summary": "Remove access to this volume from a specified [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessFromHost/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessFromHost",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromHost::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromHost::Parameters::Input",
+ "properties": {
+ "typeClassName": {
+ "type": "string"
+ },
+ "hostId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromHostList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. ",
+ "summary": "Remove access to this volume from multiple [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessFromHostList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessFromHostList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromHostList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromHostList::Parameters::Input",
+ "properties": {
+ "hostObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromIpAddress": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume. ",
+ "summary": "Remove access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessFromIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromIpAddress::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromIpAddress::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromIpAddressList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddressList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessFromIpAddressList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromIpAddressList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromIpAddressList::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromSubnet": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessFromSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromSubnet::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromSubnet::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromSubnetList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnetList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessFromSubnetList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromSubnetList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromSubnetList::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromVirtualGuest": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. ",
+ "summary": "Remove access to this volume from a specified SoftLayer_Virtual_Guest object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuest/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessFromVirtualGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromVirtualGuest::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromVirtualGuest::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromVirtualGuestList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. ",
+ "summary": "Remove access to this volume from multiple SoftLayer_Virtual_Guest objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuestList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessFromVirtualGuestList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromVirtualGuestList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessFromVirtualGuestList::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessToReplicantFromHardwareList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume. ",
+ "summary": "Remove access to this volume's replica from multiple SoftLayer_Hardware objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromHardwareList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessToReplicantFromHardwareList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessToReplicantFromHardwareList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessToReplicantFromHardwareList::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessToReplicantFromIpAddressList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume. ",
+ "summary": "Remove access to this replica volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromIpAddressList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessToReplicantFromIpAddressList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessToReplicantFromIpAddressList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessToReplicantFromIpAddressList::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessToReplicantFromSubnet": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessToReplicantFromSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessToReplicantFromSubnet::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessToReplicantFromSubnet::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessToReplicantFromSubnetList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume. ",
+ "summary": "Remove access to this volume's replica from multiple SoftLayer_Network_Subnet objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnetList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessToReplicantFromSubnetList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessToReplicantFromSubnetList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessToReplicantFromSubnetList::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessToReplicantFromVirtualGuestList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume. ",
+ "summary": "Remove access to this volume's replica from multiple SoftLayer_Virtual_Guest objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromVirtualGuestList/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeAccessToReplicantFromVirtualGuestList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessToReplicantFromVirtualGuestList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeAccessToReplicantFromVirtualGuestList::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeCredential": {
+ "post": {
+ "description": "This method will remove a credential from the current volume. The credential must have been created using the 'addNewCredential' method. ",
+ "summary": "This method will remove a credential from the current volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/removeCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage::removeCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeCredential::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::removeCredential::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/restoreFile": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Restore an individual file so that it may be used as it was before it was deleted. \n\nIf a file is deleted from a Virtual Server Storage account, the file is placed into the account's recycle bin and not permanently deleted. Therefore, restoreFile can be used to place the file back into your Virtual Server account's root directory. ",
+ "summary": "Restore access to an individual file in a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/restoreFile/"
+ },
+ "operationId": "SoftLayer_Network_Storage::restoreFile",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::restoreFile::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::restoreFile::Parameters::Input",
+ "properties": {
+ "fileId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/restoreFromSnapshot": {
+ "post": {
+ "description": "Restore the volume from a snapshot that was previously taken. ",
+ "summary": "Restore from a volume snapshot.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/restoreFromSnapshot/"
+ },
+ "operationId": "SoftLayer_Network_Storage::restoreFromSnapshot",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::restoreFromSnapshot::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::restoreFromSnapshot::Parameters::Input",
+ "properties": {
+ "snapshotId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/sendPasswordReminderEmail": {
+ "post": {
+ "description": "The method will retrieve the password for the StorageLayer or Virtual Server Storage Account and email the password. The Storage Account passwords will be emailed to the master user. For Virtual Server Storage, the password will be sent to the email address used as the username. ",
+ "summary": "Email the password for the Storage account to the master user.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/sendPasswordReminderEmail/"
+ },
+ "operationId": "SoftLayer_Network_Storage::sendPasswordReminderEmail",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::sendPasswordReminderEmail::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::sendPasswordReminderEmail::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/setMountable": {
+ "post": {
+ "description": "Enable or disable the mounting of a Storage volume. When mounting is enabled the Storage volume will be mountable or available for use. \n\nFor Virtual Server volumes, disabling mounting will deny access to the Virtual Server Account, remove published material and deny all file interaction including uploads and downloads. \n\nEnabling or disabling mounting for Storage volumes is not possible if mounting has been disabled by SoftLayer or a parent account. ",
+ "summary": "Enable or disable mounting of a Storage volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/setMountable/"
+ },
+ "operationId": "SoftLayer_Network_Storage::setMountable",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::setMountable::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::setMountable::Parameters::Input",
+ "properties": {
+ "mountable": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/setSnapshotAllocation": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/setSnapshotAllocation/"
+ },
+ "operationId": "SoftLayer_Network_Storage::setSnapshotAllocation",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::setSnapshotAllocation::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::setSnapshotAllocation::Parameters::Input",
+ "properties": {
+ "capacityGb": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/setSnapshotNotification": {
+ "post": {
+ "description": "Function to enable/disable snapshot warning notification. ",
+ "summary": "Function to enable/disable snapshot warning notification.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/setSnapshotNotification/"
+ },
+ "operationId": "SoftLayer_Network_Storage::setSnapshotNotification",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::setSnapshotNotification::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::setSnapshotNotification::Parameters::Input",
+ "properties": {
+ "notificationFlag": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/upgradeVolumeCapacity": {
+ "post": {
+ "description": "Upgrade the Storage volume to one of the upgradable packages (for example from 10 Gigs of EVault storage to 100 Gigs of EVault storage). ",
+ "summary": "Edit the Storage volume to a different package",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/upgradeVolumeCapacity/"
+ },
+ "operationId": "SoftLayer_Network_Storage::upgradeVolumeCapacity",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::upgradeVolumeCapacity::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::upgradeVolumeCapacity::Parameters::Input",
+ "properties": {
+ "itemId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/uploadFile": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Upload a file to a Storage account's root directory. Once uploaded, this method returns new file entity identifier for the upload file. \n\nThe following properties are required in the ''file'' parameter. \n*'''name''': The name of the file you wish to upload\n*'''content''': The raw contents of the file you wish to upload.\n*'''contentType''': The MIME-type of content that you wish to upload.",
+ "summary": "Upload a file to a Storage account's root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/uploadFile/"
+ },
+ "operationId": "SoftLayer_Network_Storage::uploadFile",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::uploadFile::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::uploadFile::Parameters::Input",
+ "properties": {
+ "file": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/validateHostsAccess": {
+ "post": {
+ "description": "This method is used to validate if the hosts are behind gateway or not from [SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress] objects. This returns [SoftLayer_Container_Network_Storage_HostsGatewayInformation] object containing the host details along with a boolean attribute which indicates if it's behind the gateway or not. ",
+ "summary": "An API to check if the hosts provided are behind gateway or not from",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/validateHostsAccess/"
+ },
+ "operationId": "SoftLayer_Network_Storage::validateHostsAccess",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_HostsGatewayInformation"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::validateHostsAccess::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage::validateHostsAccess::Parameters::Input",
+ "properties": {
+ "hostObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAccount": {
+ "get": {
+ "description": "The account that a Storage services belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAccountPassword": {
+ "get": {
+ "description": "Other usernames and passwords associated with a Storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAccountPassword/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAccountPassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account_Password"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getActiveTransactions": {
+ "get": {
+ "description": "The currently active transactions on a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getActiveTransactions/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getActiveTransactions",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowDisasterRecoveryFailback": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailback/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowDisasterRecoveryFailback",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowDisasterRecoveryFailover": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailover/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowDisasterRecoveryFailover",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedHardware": {
+ "get": {
+ "description": "The SoftLayer_Hardware objects which are allowed access to this storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowedHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowedHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedIpAddresses": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowedIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowedIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedReplicationHardware": {
+ "get": {
+ "description": "The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowedReplicationHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowedReplicationHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedReplicationIpAddresses": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowedReplicationIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowedReplicationIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedReplicationSubnets": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowedReplicationSubnets/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowedReplicationSubnets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedReplicationVirtualGuests": {
+ "get": {
+ "description": "The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowedReplicationVirtualGuests/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowedReplicationVirtualGuests",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedSubnets": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowedSubnets/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowedSubnets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedVirtualGuests": {
+ "get": {
+ "description": "The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getAllowedVirtualGuests/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getAllowedVirtualGuests",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getBillingItem": {
+ "get": {
+ "description": "The current billing item for a Storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getBillingItemCategory": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getBillingItemCategory/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getBillingItemCategory",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Category"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getBytesUsed": {
+ "get": {
+ "description": "The amount of space used by the volume, in bytes.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getBytesUsed/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getBytesUsed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getCreationScheduleId": {
+ "get": {
+ "description": "The schedule id which was executed to create a snapshot.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getCreationScheduleId/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getCreationScheduleId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getCredentials": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getCredentials/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getCredentials",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getDailySchedule": {
+ "get": {
+ "description": "The Daily Schedule which is associated with this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getDailySchedule/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getDailySchedule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getDependentDuplicate": {
+ "get": {
+ "description": "Whether or not a network storage volume is a dependent duplicate.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getDependentDuplicate/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getDependentDuplicate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getDependentDuplicates": {
+ "get": {
+ "description": "The network storage volumes configured to be dependent duplicates of a volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getDependentDuplicates/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getDependentDuplicates",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getEvents": {
+ "get": {
+ "description": "The events which have taken place on a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getEvents/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getEvents",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Event"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFailbackNotAllowed": {
+ "get": {
+ "description": "Determines whether the volume is allowed to failback",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFailbackNotAllowed/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFailbackNotAllowed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFailoverNotAllowed": {
+ "get": {
+ "description": "Determines whether the volume is allowed to failover",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFailoverNotAllowed/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFailoverNotAllowed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFileNetworkMountAddress": {
+ "get": {
+ "description": "Retrieves the NFS Network Mount Address Name for a given File Storage Volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFileNetworkMountAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFileNetworkMountAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFixReplicationCurrentStatus": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getFixReplicationCurrentStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getFixReplicationCurrentStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getHardware": {
+ "get": {
+ "description": "When applicable, the hardware associated with a Storage service.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getHasEncryptionAtRest": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getHasEncryptionAtRest/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getHasEncryptionAtRest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getHourlySchedule": {
+ "get": {
+ "description": "The Hourly Schedule which is associated with this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getHourlySchedule/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getHourlySchedule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIntervalSchedule": {
+ "get": {
+ "description": "The Interval Schedule which is associated with this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIntervalSchedule/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIntervalSchedule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIops": {
+ "get": {
+ "description": "The maximum number of IOPs selected for this volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIops/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIops",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsConvertToIndependentTransactionInProgress": {
+ "get": {
+ "description": "Determines whether network storage volume has an active convert dependent clone to Independent transaction.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIsConvertToIndependentTransactionInProgress/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIsConvertToIndependentTransactionInProgress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsDependentDuplicateProvisionCompleted": {
+ "get": {
+ "description": "Determines whether dependent volume provision is completed on background.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIsDependentDuplicateProvisionCompleted/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIsDependentDuplicateProvisionCompleted",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsInDedicatedServiceResource": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIsInDedicatedServiceResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIsInDedicatedServiceResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsMagneticStorage": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIsMagneticStorage/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIsMagneticStorage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsProvisionInProgress": {
+ "get": {
+ "description": "Determines whether network storage volume has an active provision transaction.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIsProvisionInProgress/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIsProvisionInProgress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsReadyForSnapshot": {
+ "get": {
+ "description": "Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIsReadyForSnapshot/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIsReadyForSnapshot",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsReadyToMount": {
+ "get": {
+ "description": "Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIsReadyToMount/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIsReadyToMount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIscsiLuns": {
+ "get": {
+ "description": "Relationship between a container volume and iSCSI LUNs.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIscsiLuns/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIscsiLuns",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIscsiReplicatingVolume": {
+ "get": {
+ "description": "The network storage volumes configured to be replicants of this volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIscsiReplicatingVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIscsiReplicatingVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIscsiTargetIpAddresses": {
+ "get": {
+ "description": "Returns the target IP addresses of an iSCSI volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getIscsiTargetIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getIscsiTargetIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getLunId": {
+ "get": {
+ "description": "The ID of the LUN volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getLunId/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getLunId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getManualSnapshots": {
+ "get": {
+ "description": "The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getManualSnapshots/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getManualSnapshots",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getMetricTrackingObject": {
+ "get": {
+ "description": "A network storage volume's metric tracking object. This object records all periodic polled data available to this volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getMetricTrackingObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getMetricTrackingObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getMountPath": {
+ "get": {
+ "description": "Retrieves the NFS Network Mount Path for a given File Storage Volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getMountPath/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getMountPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getMountableFlag": {
+ "get": {
+ "description": "Whether or not a network storage volume may be mounted.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getMountableFlag/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getMountableFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getMoveAndSplitStatus": {
+ "get": {
+ "description": "The current status of split or move operation as a part of volume duplication.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getMoveAndSplitStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getMoveAndSplitStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getNotificationSubscribers": {
+ "get": {
+ "description": "The subscribers that will be notified for usage amount warnings and overages.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getNotificationSubscribers/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getNotificationSubscribers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOriginalSnapshotName": {
+ "get": {
+ "description": "The name of the snapshot that this volume was duplicated from.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getOriginalSnapshotName/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getOriginalSnapshotName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOriginalVolumeId": {
+ "get": {
+ "description": "Volume id of the origin volume from which this volume is been cloned.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getOriginalVolumeId/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getOriginalVolumeId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOriginalVolumeName": {
+ "get": {
+ "description": "The name of the volume that this volume was duplicated from.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getOriginalVolumeName/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getOriginalVolumeName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOriginalVolumeSize": {
+ "get": {
+ "description": "The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getOriginalVolumeSize/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getOriginalVolumeSize",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOsType": {
+ "get": {
+ "description": "A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getOsType/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getOsType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Iscsi_OS_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOsTypeId": {
+ "get": {
+ "description": "A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getOsTypeId/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getOsTypeId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getParentPartnerships": {
+ "get": {
+ "description": "The volumes or snapshots partnered with a network storage volume in a parental role.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getParentPartnerships/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getParentPartnerships",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Partnership"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getParentVolume": {
+ "get": {
+ "description": "The parent volume of a volume in a complex storage relationship.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getParentVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getParentVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getPartnerships": {
+ "get": {
+ "description": "The volumes or snapshots partnered with a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getPartnerships/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getPartnerships",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Partnership"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getPermissionsGroups": {
+ "get": {
+ "description": "All permissions group(s) this volume is in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getPermissionsGroups/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getPermissionsGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getProperties": {
+ "get": {
+ "description": "The properties used to provide additional details about a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getProperties/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getProperties",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Property"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getProvisionedIops": {
+ "get": {
+ "description": "The number of IOPs provisioned for this volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getProvisionedIops/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getProvisionedIops",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicatingLuns": {
+ "get": {
+ "description": "The iSCSI LUN volumes being replicated by this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getReplicatingLuns/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getReplicatingLuns",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicatingVolume": {
+ "get": {
+ "description": "The network storage volume being replicated by a volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getReplicatingVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getReplicatingVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicationEvents": {
+ "get": {
+ "description": "The volume replication events.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getReplicationEvents/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getReplicationEvents",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Event"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicationPartners": {
+ "get": {
+ "description": "The network storage volumes configured to be replicants of a volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getReplicationPartners/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getReplicationPartners",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicationSchedule": {
+ "get": {
+ "description": "The Replication Schedule associated with a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getReplicationSchedule/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getReplicationSchedule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicationStatus": {
+ "get": {
+ "description": "The current replication status of a network storage volume. Indicates Failover or Failback status.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getReplicationStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getReplicationStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSchedules": {
+ "get": {
+ "description": "The schedules which are associated with a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getSchedules/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getSchedules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getServiceResource": {
+ "get": {
+ "description": "The network resource a Storage service is connected to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getServiceResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getServiceResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getServiceResourceBackendIpAddress": {
+ "get": {
+ "description": "The IP address of a Storage resource.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getServiceResourceBackendIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getServiceResourceBackendIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getServiceResourceName": {
+ "get": {
+ "description": "The name of a Storage's network resource.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getServiceResourceName/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getServiceResourceName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotCapacityGb": {
+ "get": {
+ "description": "A volume's configured snapshot space size.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getSnapshotCapacityGb/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getSnapshotCapacityGb",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotCreationTimestamp": {
+ "get": {
+ "description": "The creation timestamp of the snapshot on the storage platform.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getSnapshotCreationTimestamp/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getSnapshotCreationTimestamp",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotDeletionThresholdPercentage": {
+ "get": {
+ "description": "The percentage of used snapshot space after which to delete automated snapshots.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getSnapshotDeletionThresholdPercentage/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getSnapshotDeletionThresholdPercentage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotNotificationStatus": {
+ "get": {
+ "description": "Whether or not a network storage volume may be mounted.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getSnapshotNotificationStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getSnapshotNotificationStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotSizeBytes": {
+ "get": {
+ "description": "The snapshot size in bytes.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getSnapshotSizeBytes/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getSnapshotSizeBytes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotSpaceAvailable": {
+ "get": {
+ "description": "A volume's available snapshot reservation space.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getSnapshotSpaceAvailable/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getSnapshotSpaceAvailable",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshots": {
+ "get": {
+ "description": "The snapshots associated with this SoftLayer_Network_Storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getSnapshots/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getSnapshots",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getStaasVersion": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getStaasVersion/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getStaasVersion",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getStorageGroups": {
+ "get": {
+ "description": "The network storage groups this volume is attached to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getStorageGroups/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getStorageGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getStorageTierLevel": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getStorageTierLevel/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getStorageTierLevel",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getStorageType": {
+ "get": {
+ "description": "A description of the Storage object.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getStorageType/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getStorageType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getTotalBytesUsed": {
+ "get": {
+ "description": "The amount of space used by the volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getTotalBytesUsed/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getTotalBytesUsed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getTotalScheduleSnapshotRetentionCount": {
+ "get": {
+ "description": "The total snapshot retention count of all schedules on this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getTotalScheduleSnapshotRetentionCount/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getTotalScheduleSnapshotRetentionCount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getUsageNotification": {
+ "get": {
+ "description": "The usage notification for SL Storage services.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getUsageNotification/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getUsageNotification",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Notification"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getVendorName": {
+ "get": {
+ "description": "The type of network storage service.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getVendorName/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getVendorName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getVirtualGuest": {
+ "get": {
+ "description": "When applicable, the virtual guest associated with a Storage service.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getVirtualGuest/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getVirtualGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getVolumeHistory": {
+ "get": {
+ "description": "The username and password history for a Storage service.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getVolumeHistory/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getVolumeHistory",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_History"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getVolumeStatus": {
+ "get": {
+ "description": "The current status of a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getVolumeStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getVolumeStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getWebccAccount": {
+ "get": {
+ "description": "The account username and password for the EVault webCC interface.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getWebccAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getWebccAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account_Password"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getWeeklySchedule": {
+ "get": {
+ "description": "The Weekly Schedule which is associated with this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage/getWeeklySchedule/"
+ },
+ "operationId": "SoftLayer_Network_Storage::getWeeklySchedule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_StorageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/assignSubnetsToAcl": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/assignSubnetsToAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::assignSubnetsToAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host::assignSubnetsToAcl::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host::assignSubnetsToAcl::Parameters::Input",
+ "properties": {
+ "subnetIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Storage_Allowed_Host record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/removeSubnetsFromAcl": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/removeSubnetsFromAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::removeSubnetsFromAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host::removeSubnetsFromAcl::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host::removeSubnetsFromAcl::Parameters::Input",
+ "properties": {
+ "subnetIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/setCredentialPassword": {
+ "post": {
+ "description": "Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object. ",
+ "summary": "Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/setCredentialPassword/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::setCredentialPassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host::setCredentialPassword::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host::setCredentialPassword::Parameters::Input",
+ "properties": {
+ "password": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/getAssignedGroups": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedGroups/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::getAssignedGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/getAssignedIscsiVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedIscsiVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::getAssignedIscsiVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/getAssignedNfsVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedNfsVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::getAssignedNfsVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/getAssignedReplicationVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedReplicationVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::getAssignedReplicationVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/getAssignedVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::getAssignedVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/getCredential": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage_Credential this allowed host uses.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/getCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::getCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/getSourceSubnet": {
+ "get": {
+ "description": "Connections to a target with a source IP in this subnet prefix are allowed.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSourceSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::getSourceSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/getSubnetsInAcl": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSubnetsInAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host::getSubnetsInAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_HostID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Storage_Allowed_Host_Hardware record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/assignSubnetsToAcl": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/assignSubnetsToAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::assignSubnetsToAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Hardware::assignSubnetsToAcl::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Hardware::assignSubnetsToAcl::Parameters::Input",
+ "properties": {
+ "subnetIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Hardware::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Hardware::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/removeSubnetsFromAcl": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/removeSubnetsFromAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::removeSubnetsFromAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Hardware::removeSubnetsFromAcl::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Hardware::removeSubnetsFromAcl::Parameters::Input",
+ "properties": {
+ "subnetIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/setCredentialPassword": {
+ "post": {
+ "description": "Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object. ",
+ "summary": "Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/setCredentialPassword/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::setCredentialPassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Hardware::setCredentialPassword::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Hardware::setCredentialPassword::Parameters::Input",
+ "properties": {
+ "password": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getAccount": {
+ "get": {
+ "description": "The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getResource": {
+ "get": {
+ "description": "The SoftLayer_Hardware object which this SoftLayer_Network_Storage_Allowed_Host is referencing.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getAssignedGroups": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedGroups/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getAssignedGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getAssignedIscsiVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedIscsiVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getAssignedIscsiVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getAssignedNfsVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedNfsVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getAssignedNfsVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getAssignedReplicationVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedReplicationVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getAssignedReplicationVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getAssignedVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getAssignedVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getCredential": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage_Credential this allowed host uses.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getSourceSubnet": {
+ "get": {
+ "description": "Connections to a target with a source IP in this subnet prefix are allowed.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSourceSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getSourceSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/getSubnetsInAcl": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSubnetsInAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Hardware::getSubnetsInAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_HardwareID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Hardware object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Storage_Allowed_Host_IpAddress record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host_IpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/assignSubnetsToAcl": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/assignSubnetsToAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::assignSubnetsToAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::assignSubnetsToAcl::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::assignSubnetsToAcl::Parameters::Input",
+ "properties": {
+ "subnetIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/removeSubnetsFromAcl": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/removeSubnetsFromAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::removeSubnetsFromAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::removeSubnetsFromAcl::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::removeSubnetsFromAcl::Parameters::Input",
+ "properties": {
+ "subnetIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/setCredentialPassword": {
+ "post": {
+ "description": "Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object. ",
+ "summary": "Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/setCredentialPassword/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::setCredentialPassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::setCredentialPassword::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::setCredentialPassword::Parameters::Input",
+ "properties": {
+ "password": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getAccount": {
+ "get": {
+ "description": "The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getResource": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet_IpAddress object which this SoftLayer_Network_Storage_Allowed_Host is referencing.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getAssignedGroups": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedGroups/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getAssignedGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getAssignedIscsiVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedIscsiVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getAssignedIscsiVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getAssignedNfsVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedNfsVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getAssignedNfsVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getAssignedReplicationVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedReplicationVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getAssignedReplicationVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getAssignedVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getAssignedVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getCredential": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage_Credential this allowed host uses.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getSourceSubnet": {
+ "get": {
+ "description": "Connections to a target with a source IP in this subnet prefix are allowed.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSourceSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getSourceSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/getSubnetsInAcl": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSubnetsInAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_IpAddress::getSubnetsInAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_IpAddressID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_IpAddress object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Storage_Allowed_Host_Subnet record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host_Subnet"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/assignSubnetsToAcl": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/assignSubnetsToAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::assignSubnetsToAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Subnet::assignSubnetsToAcl::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Subnet::assignSubnetsToAcl::Parameters::Input",
+ "properties": {
+ "subnetIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Subnet::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Subnet::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/removeSubnetsFromAcl": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/removeSubnetsFromAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::removeSubnetsFromAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Subnet::removeSubnetsFromAcl::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Subnet::removeSubnetsFromAcl::Parameters::Input",
+ "properties": {
+ "subnetIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/setCredentialPassword": {
+ "post": {
+ "description": "Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object. ",
+ "summary": "Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/setCredentialPassword/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::setCredentialPassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Subnet::setCredentialPassword::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_Subnet::setCredentialPassword::Parameters::Input",
+ "properties": {
+ "password": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getAccount": {
+ "get": {
+ "description": "The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getResource": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet object which this SoftLayer_Network_Storage_Allowed_Host is referencing.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getAssignedGroups": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedGroups/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getAssignedGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getAssignedIscsiVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedIscsiVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getAssignedIscsiVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getAssignedNfsVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedNfsVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getAssignedNfsVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getAssignedReplicationVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedReplicationVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getAssignedReplicationVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getAssignedVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getAssignedVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getCredential": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage_Credential this allowed host uses.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getSourceSubnet": {
+ "get": {
+ "description": "Connections to a target with a source IP in this subnet prefix are allowed.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSourceSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getSourceSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/getSubnetsInAcl": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSubnetsInAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_Subnet::getSubnetsInAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_SubnetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_Subnet object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/assignSubnetsToAcl": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/assignSubnetsToAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::assignSubnetsToAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::assignSubnetsToAcl::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::assignSubnetsToAcl::Parameters::Input",
+ "properties": {
+ "subnetIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/removeSubnetsFromAcl": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/removeSubnetsFromAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::removeSubnetsFromAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::removeSubnetsFromAcl::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::removeSubnetsFromAcl::Parameters::Input",
+ "properties": {
+ "subnetIds": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/setCredentialPassword": {
+ "post": {
+ "description": "Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object. ",
+ "summary": "Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/setCredentialPassword/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::setCredentialPassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::setCredentialPassword::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::setCredentialPassword::Parameters::Input",
+ "properties": {
+ "password": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getAccount": {
+ "get": {
+ "description": "The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getResource": {
+ "get": {
+ "description": "The SoftLayer_Virtual_Guest object which this SoftLayer_Network_Storage_Allowed_Host is referencing.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getAssignedGroups": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedGroups/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getAssignedGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getAssignedIscsiVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedIscsiVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getAssignedIscsiVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getAssignedNfsVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedNfsVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getAssignedNfsVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getAssignedReplicationVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedReplicationVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getAssignedReplicationVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getAssignedVolumes": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getAssignedVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getCredential": {
+ "get": {
+ "description": "The SoftLayer_Network_Storage_Credential this allowed host uses.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getSourceSubnet": {
+ "get": {
+ "description": "Connections to a target with a source IP in this subnet prefix are allowed.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSourceSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getSourceSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/getSubnetsInAcl": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSubnetsInAcl/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest::getSubnetsInAcl",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/deleteTasks": {
+ "post": {
+ "description": "This method can be used to help maintain the storage space on a vault. When a job is removed from the Webcc, the task and stored usage still exists on the vault. This method can be used to delete the associated task and its usage. \n\nAll that is required for the use of the method is to pass in an integer array of task(s). \n\n",
+ "summary": "Delete task(s)",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteTasks/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::deleteTasks",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::deleteTasks::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::deleteTasks::Parameters::Input",
+ "properties": {
+ "tasks": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/getHardwareWithEvaultFirst": {
+ "post": {
+ "description": "Retrieve a list of hardware associated with a SoftLayer customer account, placing all hardware with associated EVault storage accounts at the beginning of the list. The return type is SoftLayer_Hardware_Server[] contains the results; the number of items returned in the result will be returned in the soap header (totalItems). ''getHardwareWithEvaultFirst'' is useful in situations where you wish to search for hardware and provide paginated output. \n\n\n\n\n\nResults are only returned for hardware belonging to the account of the user making the API call. \n\nThis method drives the backup page of the SoftLayer customer portal. It serves a very specific function, but we have exposed it as it may prove useful for API developers too. ",
+ "summary": "Retrieve all the hardware for the account listing the hardware with EVault Storage service first. The output will be paginated having 25 items on each page. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardwareWithEvaultFirst/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getHardwareWithEvaultFirst",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getHardwareWithEvaultFirst::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getHardwareWithEvaultFirst::Parameters::Input",
+ "properties": {
+ "option": {
+ "type": "string"
+ },
+ "exactMatch": {
+ "type": "boolean"
+ },
+ "criteria": {
+ "type": "string"
+ },
+ "mode": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Network_Storage_Backup_Evault object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Storage_Backup_Evault service. ",
+ "summary": "Retrieve a SoftLayer_Network_Storage_Backup_Evault record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Backup_Evault"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/getWebCCAuthenticationDetails": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve WebCC authentication details value. This value is required for the login process associated to the session information for WebCC. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebCCAuthenticationDetails/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getWebCCAuthenticationDetails",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Backup_Evault_WebCc_Authentication_Details"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/initiateBareMetalRestore": {
+ "get": {
+ "description": "Evault Bare Metal Restore is a special version of Rescue Kernel designed specifically for making full system restores made with Evault's BMR backup. This process works very similar to Rescue Kernel, except only the Evault restore program is available. The process takes approximately 10 minutes. Once completed you will be able to access your server to do a restore through VNC or your servers KVM-over-IP. IP information and credentials can be found on the hardware page of the customer portal. The Evault Application will be running automatically upon startup, and will walk you through the restore process. ",
+ "summary": "Initiate a bare metal restore for the server tied to the EVault account",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestore/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::initiateBareMetalRestore",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/initiateBareMetalRestoreForServer": {
+ "post": {
+ "description": "This method operates the same as the initiateBareMetalRestore() method. However, using this method, the Bare Metal Restore can be initiated on any Windows server under the account. ",
+ "summary": "Initiate a bare metal restore for the specified server",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestoreForServer/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::initiateBareMetalRestoreForServer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::initiateBareMetalRestoreForServer::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::initiateBareMetalRestoreForServer::Parameters::Input",
+ "properties": {
+ "hardwareId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromHardware": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. ",
+ "summary": "Allow access to this volume from a specified SoftLayer_Hardware object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHardware::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHardware::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromHardwareList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardwareList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHardwareList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHardwareList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHardwareList::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromHost": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. ",
+ "summary": "Allow access to this volume from a specified [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHost/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHost",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHost::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHost::Parameters::Input",
+ "properties": {
+ "typeClassName": {
+ "type": "string"
+ },
+ "hostId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromHostList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage volume will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. ",
+ "summary": "Allow access to this volume from multiple [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHostList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHostList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHostList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromHostList::Parameters::Input",
+ "properties": {
+ "hostObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromIpAddress": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume. ",
+ "summary": "Allow access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromIpAddress::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromIpAddress::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromIpAddressList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddressList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromIpAddressList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromIpAddressList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromIpAddressList::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromSubnet": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. ",
+ "summary": "Allow access to this volume from multiple SoftLayer_Network_Subnet objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromSubnet::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromSubnet::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromSubnetList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnetList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromSubnetList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromSubnetList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromSubnetList::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromVirtualGuest": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. ",
+ "summary": "Allow access to this volume from a specified SoftLayer_Virtual_Guest object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuest/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromVirtualGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromVirtualGuest::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromVirtualGuest::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromVirtualGuestList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. ",
+ "summary": "Allow access to this volume from multiple SoftLayer_Virtual_Guest objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuestList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromVirtualGuestList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromVirtualGuestList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessFromVirtualGuestList::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessToReplicantFromHardware": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume. ",
+ "summary": "Allow access to this replicant volume from a specified SoftLayer_Hardware object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromHardware::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromHardware::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessToReplicantFromHardwareList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume. ",
+ "summary": "allow access to this volume's replica from multiple SoftLayer_Hardware objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardwareList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromHardwareList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromHardwareList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromHardwareList::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessToReplicantFromIpAddress": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromIpAddress::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromIpAddress::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessToReplicantFromIpAddressList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume. ",
+ "summary": "allow access to this volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddressList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromIpAddressList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromIpAddressList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromIpAddressList::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessToReplicantFromSubnet": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume. ",
+ "summary": "Allow access to this replicant volume from multiple SoftLayer_Network_Subnet objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromSubnet::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromSubnet::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessToReplicantFromSubnetList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume. ",
+ "summary": "allow access to this volume's replica from multiple SoftLayer_Network_Subnet objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnetList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromSubnetList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromSubnetList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromSubnetList::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessToReplicantFromVirtualGuest": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replicant volume. ",
+ "summary": "Allow access to this replicant volume from a specified SoftLayer_Virtual_Guest object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuest/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromVirtualGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromVirtualGuest::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromVirtualGuest::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessToReplicantFromVirtualGuestList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume. ",
+ "summary": "allow access to this volume's replica from multiple SoftLayer_Virtual_Guest objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuestList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromVirtualGuestList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromVirtualGuestList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::allowAccessToReplicantFromVirtualGuestList::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/assignCredential": {
+ "post": {
+ "description": "This method will assign an existing credential to the current volume. The credential must have been created using the 'addNewCredential' method. The volume type must support an additional credential. ",
+ "summary": "This method will assign an existing credential to the current volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::assignCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::assignCredential::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::assignCredential::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/assignNewCredential": {
+ "post": {
+ "description": "This method will set up a new credential for the remote storage volume. The storage volume must support an additional credential. Once created, the credential will be automatically assigned to the current volume. If there are no volumes assigned to the credential it will be automatically deleted. ",
+ "summary": "This method will set up a new credential for the remote storage volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignNewCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::assignNewCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::assignNewCredential::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::assignNewCredential::Parameters::Input",
+ "properties": {
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/changePassword": {
+ "post": {
+ "description": "The method will change the password for the given Storage/Virtual Server Storage account. ",
+ "summary": "Change the password for a Storage/Virtual Server Storage account",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/changePassword/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::changePassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::changePassword::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::changePassword::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ },
+ "currentPassword": {
+ "type": "string"
+ },
+ "newPassword": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/collectBandwidth": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} \n\ncollectBandwidth() Retrieve the bandwidth usage for the current billing cycle. ",
+ "summary": "Retrieve the bandwidth usage for the current billing cycle.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBandwidth/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::collectBandwidth",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::collectBandwidth::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::collectBandwidth::Parameters::Input",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "startDate": {
+ "type": "string"
+ },
+ "endDate": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/collectBytesUsed": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} \n\ncollectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account. ",
+ "summary": "Retrieve the number of bytes capacity currently in use on a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBytesUsed/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::collectBytesUsed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/convertCloneDependentToIndependent": {
+ "get": {
+ "description": null,
+ "summary": "Splits a clone from its parent allowing it to be an independent volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/convertCloneDependentToIndependent/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::convertCloneDependentToIndependent",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/createFolder": {
+ "post": {
+ "description": null,
+ "summary": "Create a new folder in the root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/createFolder/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::createFolder",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::createFolder::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::createFolder::Parameters::Input",
+ "properties": {
+ "folder": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/createOrUpdateLunId": {
+ "post": {
+ "description": "The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method. ",
+ "summary": "Creates or updates the LUN ID property on a volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/createOrUpdateLunId/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::createOrUpdateLunId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Property"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::createOrUpdateLunId::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::createOrUpdateLunId::Parameters::Input",
+ "properties": {
+ "lunId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/createSnapshot": {
+ "post": {
+ "description": null,
+ "summary": "Manually create a new snapshot of a storage volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/createSnapshot/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::createSnapshot",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::createSnapshot::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::createSnapshot::Parameters::Input",
+ "properties": {
+ "notes": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/deleteAllFiles": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} Delete all files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin. \n\nCurrently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted. \n\nPlease note, files can not be restored once they are permanently deleted. ",
+ "summary": "Delete all files within a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteAllFiles/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::deleteAllFiles",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/deleteFile": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account's recycle bin. \n\nCurrently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account's recycle bin. If the file exist in the recycle bin, then it is permanently deleted. \n\nPlease note, a file can not be restored once it is permanently deleted. ",
+ "summary": "Delete an individual file within a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFile/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::deleteFile",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::deleteFile::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::deleteFile::Parameters::Input",
+ "properties": {
+ "fileId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/deleteFiles": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Delete multiple files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin. \n\nCurrently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted. \n\nPlease note, files can not be restored once they are permanently deleted. ",
+ "summary": "Delete multiple files within a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFiles/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::deleteFiles",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::deleteFiles::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::deleteFiles::Parameters::Input",
+ "properties": {
+ "fileIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/deleteFolder": {
+ "post": {
+ "description": null,
+ "summary": "Delete a folder in the root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFolder/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::deleteFolder",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::deleteFolder::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::deleteFolder::Parameters::Input",
+ "properties": {
+ "folder": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/deleteObject": {
+ "get": {
+ "description": "Delete a network storage volume. '''This cannot be undone.''' At this time only network storage snapshots may be deleted with this method. \n\n''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a volume; ",
+ "summary": "Delete a network storage volume",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/disableSnapshots": {
+ "post": {
+ "description": "This method is not valid for Legacy iSCSI Storage Volumes. \n\nDisable scheduled snapshots of this storage volume. Scheduling options include 'INTERVAL', HOURLY, DAILY and WEEKLY schedules. ",
+ "summary": "Disable snapshots of this Storage Volume on a schedule.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/disableSnapshots/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::disableSnapshots",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::disableSnapshots::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::disableSnapshots::Parameters::Input",
+ "properties": {
+ "scheduleType": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/disasterRecoveryFailoverToReplicant": {
+ "post": {
+ "description": "If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately failover to an available replica in another location. This method does not allow for fail back via the API. To fail back to the original volume after using this method, open a support ticket. To test failover, use [[SoftLayer_Network_Storage::failoverToReplicant]] instead. ",
+ "summary": "Failover an inaccessible block/file volume to its available replicant volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/disasterRecoveryFailoverToReplicant/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::disasterRecoveryFailoverToReplicant",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::disasterRecoveryFailoverToReplicant::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::disasterRecoveryFailoverToReplicant::Parameters::Input",
+ "properties": {
+ "replicantId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/downloadFile": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Download a file from a Storage account. This method returns a file's details including the file's raw content. ",
+ "summary": "Download a file from a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/downloadFile/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::downloadFile",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::downloadFile::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::downloadFile::Parameters::Input",
+ "properties": {
+ "fileId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/editCredential": {
+ "post": {
+ "description": "This method will change the password of a credential created using the 'addNewCredential' method. If the credential exists on multiple storage volumes it will change for those volumes as well. ",
+ "summary": "This method will change the password of a credential created using the 'addNewCredential' method.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/editCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::editCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::editCredential::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::editCredential::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ },
+ "newPassword": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/editObject": {
+ "post": {
+ "description": "The password and/or notes may be modified for the Storage service except evault passwords and notes. ",
+ "summary": "Edit the password and/or notes for the Storage service",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/enableSnapshots": {
+ "post": {
+ "description": "This method is not valid for Legacy iSCSI Storage Volumes. \n\nEnable scheduled snapshots of this storage volume. Scheduling options include HOURLY, DAILY and WEEKLY schedules. For HOURLY schedules, provide relevant data for $scheduleType, $retentionCount and $minute. For DAILY schedules, provide relevant data for $scheduleType, $retentionCount, $minute, and $hour. For WEEKLY schedules, provide relevant data for all parameters of this method. ",
+ "summary": "Enable snapshots of this Storage Volume on a schedule.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/enableSnapshots/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::enableSnapshots",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::enableSnapshots::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::enableSnapshots::Parameters::Input",
+ "properties": {
+ "scheduleType": {
+ "type": "string"
+ },
+ "retentionCount": {
+ "type": "number"
+ },
+ "minute": {
+ "type": "number"
+ },
+ "hour": {
+ "type": "number"
+ },
+ "dayOfWeek": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/failbackFromReplicant": {
+ "get": {
+ "description": "Failback from a volume replicant. In order to failback the volume must have already been failed over to a replicant. ",
+ "summary": "Failback from a volume replicant.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/failbackFromReplicant/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::failbackFromReplicant",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/failoverToReplicant": {
+ "post": {
+ "description": "Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available. ",
+ "summary": "Failover to a volume replicant.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/failoverToReplicant/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::failoverToReplicant",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::failoverToReplicant::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::failoverToReplicant::Parameters::Input",
+ "properties": {
+ "replicantId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllFiles": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory. This does not download file content. ",
+ "summary": "Retrieve a listing of all files in a Storage account's root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFiles/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllFiles",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllFilesByFilter": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory. This does not download file content. ",
+ "summary": "Retrieve a listing of all files matching the filter's criteria in a Storage account's root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFilesByFilter/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllFilesByFilter",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getAllFilesByFilter::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getAllFilesByFilter::Parameters::Input",
+ "properties": {
+ "filter": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowableHardware": {
+ "post": {
+ "description": "This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage. ",
+ "summary": "Return a list of SoftLayer_Hardware that can be authorized to this volume. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowableHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getAllowableHardware::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getAllowableHardware::Parameters::Input",
+ "properties": {
+ "filterHostname": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowableIpAddresses": {
+ "post": {
+ "description": "This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage. ",
+ "summary": "Return a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this volume. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowableIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getAllowableIpAddresses::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getAllowableIpAddresses::Parameters::Input",
+ "properties": {
+ "subnetId": {
+ "type": "number"
+ },
+ "filterIpAddress": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowableSubnets": {
+ "post": {
+ "description": "This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage. ",
+ "summary": "Return a list of SoftLayer_Network_Subnet that can be authorized to this volume. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableSubnets/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowableSubnets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getAllowableSubnets::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getAllowableSubnets::Parameters::Input",
+ "properties": {
+ "filterNetworkIdentifier": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowableVirtualGuests": {
+ "post": {
+ "description": "This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage. ",
+ "summary": "Return a list of SoftLayer_Virtual_Guest that can be authorized to this volume. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableVirtualGuests/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowableVirtualGuests",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getAllowableVirtualGuests::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getAllowableVirtualGuests::Parameters::Input",
+ "properties": {
+ "filterHostname": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowedHostsLimit": {
+ "get": {
+ "description": "Retrieves the total number of allowed hosts limit per volume. ",
+ "summary": "Retrieves the total number of allowed hosts limit per volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHostsLimit/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowedHostsLimit",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/getByUsername": {
+ "post": {
+ "description": "Retrieve network storage accounts by username and storage account type. Use this method if you wish to retrieve a storage record by username rather than by id. The ''type'' parameter must correspond to one of the available ''nasType'' values in the SoftLayer_Network_Storage data type. ",
+ "summary": "Retrieve network storage accounts by username. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getByUsername/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getByUsername",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getByUsername::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getByUsername::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getCdnUrls": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCdnUrls/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getCdnUrls",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getClusterResource": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getClusterResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getClusterResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getDuplicateConversionStatus": {
+ "get": {
+ "description": "This method is used to check, if for the given classic file block storage volume, a transaction performing dependent to independent duplicate conversion is active. If yes, then this returns the current percentage of its progress along with its start time as [SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation] object with its name, percentage and transaction start timestamp. ",
+ "summary": "An API to fetch the percentage progress of conversion of a dependent",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDuplicateConversionStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getDuplicateConversionStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/getFileBlockEncryptedLocations": {
+ "get": {
+ "description": "\n\n",
+ "summary": "Returns a list of SoftLayer_Location_Datacenter objects corresponding to Datacenters in which File and Block Storage Volumes with Encryption at Rest may be ordered. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileBlockEncryptedLocations/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFileBlockEncryptedLocations",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Location"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFileByIdentifier": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date of a file within a Storage account. This does not download file content. ",
+ "summary": "Retrieve an individual file's details.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileByIdentifier/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFileByIdentifier",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getFileByIdentifier::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getFileByIdentifier::Parameters::Input",
+ "properties": {
+ "identifier": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFileCount": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve the file number of files in a Virtual Server Storage account's root directory. This does not include the files stored in the recycle bin. ",
+ "summary": "Retrieve the file number of files in a Virtual Server Storage account's root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileCount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFileCount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFileList": {
+ "post": {
+ "description": null,
+ "summary": "Retrieve list of files in a given folder for this account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFileList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getFileList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getFileList::Parameters::Input",
+ "properties": {
+ "folder": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFilePendingDeleteCount": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve the number of files pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted. ",
+ "summary": "Retrieve the number of files pending deletion in a Storage account's recycle bin.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilePendingDeleteCount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFilePendingDeleteCount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFilesPendingDelete": {
+ "get": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve a list of files that are pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted. This method does not download file content. ",
+ "summary": "Retrieve a list of files in a Storage account's recycle bin.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilesPendingDelete/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFilesPendingDelete",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFolderList": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a list of level 1 folders for this account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFolderList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFolderList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Folder"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getGraph": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} \n\ngetGraph() 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. ",
+ "summary": "Retrieve a graph representing the bandwidth used by a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getGraph/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getGraph",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getGraph::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getGraph::Parameters::Input",
+ "properties": {
+ "startDate": {
+ "type": "string"
+ },
+ "endDate": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getMaximumExpansionSize": {
+ "get": {
+ "description": null,
+ "summary": "Returns the maximum volume expansion size in GB.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMaximumExpansionSize/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getMaximumExpansionSize",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getNetworkConnectionDetails": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve network connection details for complex network storage volumes.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkConnectionDetails/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getNetworkConnectionDetails",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_NetworkConnectionInformation"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getNetworkMountAddress": {
+ "get": {
+ "description": null,
+ "summary": "Displays the mount path of a storage volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getNetworkMountAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getNetworkMountPath": {
+ "get": {
+ "description": null,
+ "summary": "Displays the mount path of a storage volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountPath/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getNetworkMountPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/getObjectStorageConnectionInformation": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve all object storage details for connection",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectStorageConnectionInformation/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getObjectStorageConnectionInformation",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Service_Resource_ObjectStorage_ConnectionInformation"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/getObjectsByCredential": {
+ "post": {
+ "description": "Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. Use this method if you wish to retrieve a storage record by a credential rather than by id. ",
+ "summary": "Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectsByCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getObjectsByCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getObjectsByCredential::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getObjectsByCredential::Parameters::Input",
+ "properties": {
+ "credentialObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getRecycleBinFileByIdentifier": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Retrieve the details of a file that is pending deletion in a Storage account's a recycle bin. ",
+ "summary": "Retrieve all files that are in the recycle bin (pending delete). This method is only used for Virtual Server Storage accounts at moment but may expanded to other Storage types in the future.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRecycleBinFileByIdentifier/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getRecycleBinFileByIdentifier",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getRecycleBinFileByIdentifier::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::getRecycleBinFileByIdentifier::Parameters::Input",
+ "properties": {
+ "fileId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getRemainingAllowedHosts": {
+ "get": {
+ "description": "Retrieves the remaining number of allowed hosts per volume. ",
+ "summary": "Retrieves the remaining number of allowed hosts per volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHosts/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getRemainingAllowedHosts",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getRemainingAllowedHostsForReplicant": {
+ "get": {
+ "description": "Retrieves the remaining number of allowed hosts for a volume's replicant. ",
+ "summary": "Retrieves the remaining number of allowed hosts for a volume's replicant.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHostsForReplicant/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getRemainingAllowedHostsForReplicant",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getReplicationTimestamp": {
+ "get": {
+ "description": null,
+ "summary": "An API call to fetch the last timestamp of the replication process",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationTimestamp/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getReplicationTimestamp",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshotsForVolume": {
+ "get": {
+ "description": "Retrieves a list of snapshots for this SoftLayer_Network_Storage volume. This method works with the result limits and offset to support pagination. ",
+ "summary": "Retrieves a list o\u0192f snapshots for a given volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotsForVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getSnapshotsForVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getStorageGroupsNetworkConnectionDetails": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroupsNetworkConnectionDetails/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getStorageGroupsNetworkConnectionDetails",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_NetworkConnectionInformation"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getTargetIpAddresses": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTargetIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getTargetIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getValidReplicationTargetDatacenterLocations": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getValidReplicationTargetDatacenterLocations/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getValidReplicationTargetDatacenterLocations",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Location"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/getVolumeCountLimits": {
+ "get": {
+ "description": "Retrieves an array of volume count limits per location and globally. ",
+ "summary": "Retrieves an array of volume count limits per location and globally.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeCountLimits/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getVolumeCountLimits",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getVolumeDuplicateParameters": {
+ "get": {
+ "description": "This method returns the parameters for cloning a volume ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeDuplicateParameters/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getVolumeDuplicateParameters",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_VolumeDuplicateParameters"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/immediateFailoverToReplicant": {
+ "post": {
+ "description": "Immediate Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available. ",
+ "summary": "Immediate Failover to a volume replicant.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/immediateFailoverToReplicant/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::immediateFailoverToReplicant",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::immediateFailoverToReplicant::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::immediateFailoverToReplicant::Parameters::Input",
+ "properties": {
+ "replicantId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/initiateOriginVolumeReclaim": {
+ "get": {
+ "description": null,
+ "summary": "Initiates Origin Volume Reclaim to delete volume from NetApp.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateOriginVolumeReclaim/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::initiateOriginVolumeReclaim",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/initiateVolumeCutover": {
+ "get": {
+ "description": null,
+ "summary": "Initiates Volume Cutover to remove access from the old volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateVolumeCutover/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::initiateVolumeCutover",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/isBlockingOperationInProgress": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/isBlockingOperationInProgress/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::isBlockingOperationInProgress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::isBlockingOperationInProgress::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::isBlockingOperationInProgress::Parameters::Input",
+ "properties": {
+ "exemptStatusKeyNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/isDuplicateReadyForSnapshot": {
+ "get": {
+ "description": "This method returns a boolean indicating whether the clone volume is ready for snapshot. ",
+ "summary": "Displays the if clone snapshots can be ordered.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyForSnapshot/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::isDuplicateReadyForSnapshot",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/isDuplicateReadyToMount": {
+ "get": {
+ "description": "This method returns a boolean indicating whether the clone volume is ready to mount. ",
+ "summary": "Displays the status of a clone mount.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyToMount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::isDuplicateReadyToMount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/isVolumeActive": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/isVolumeActive/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::isVolumeActive",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/refreshDependentDuplicate": {
+ "post": {
+ "description": null,
+ "summary": "Refreshes a duplicate volume with a snapshot taken from its parent. This is deprecated now.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDependentDuplicate/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::refreshDependentDuplicate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::refreshDependentDuplicate::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::refreshDependentDuplicate::Parameters::Input",
+ "properties": {
+ "snapshotId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/refreshDuplicate": {
+ "post": {
+ "description": null,
+ "summary": "Refreshes any duplicate volume with a snapshot taken from its parent.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDuplicate/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::refreshDuplicate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::refreshDuplicate::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::refreshDuplicate::Parameters::Input",
+ "properties": {
+ "snapshotId": {
+ "type": "number"
+ },
+ "forceRefresh": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromHardware": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. ",
+ "summary": "Remove access to this volume from a specified SoftLayer_Hardware object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHardware::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHardware::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromHardwareList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. ",
+ "summary": "Remove access to this volume from multiple SoftLayer_Hardware objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardwareList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHardwareList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHardwareList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHardwareList::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromHost": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. ",
+ "summary": "Remove access to this volume from a specified [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHost/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHost",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHost::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHost::Parameters::Input",
+ "properties": {
+ "typeClassName": {
+ "type": "string"
+ },
+ "hostId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromHostList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. ",
+ "summary": "Remove access to this volume from multiple [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHostList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHostList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHostList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromHostList::Parameters::Input",
+ "properties": {
+ "hostObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromIpAddress": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume. ",
+ "summary": "Remove access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromIpAddress::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromIpAddress::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromIpAddressList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddressList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromIpAddressList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromIpAddressList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromIpAddressList::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromSubnet": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromSubnet::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromSubnet::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromSubnetList": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnetList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromSubnetList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromSubnetList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromSubnetList::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromVirtualGuest": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. ",
+ "summary": "Remove access to this volume from a specified SoftLayer_Virtual_Guest object.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuest/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromVirtualGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromVirtualGuest::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromVirtualGuest::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromVirtualGuestList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. ",
+ "summary": "Remove access to this volume from multiple SoftLayer_Virtual_Guest objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuestList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromVirtualGuestList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromVirtualGuestList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessFromVirtualGuestList::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessToReplicantFromHardwareList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume. ",
+ "summary": "Remove access to this volume's replica from multiple SoftLayer_Hardware objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromHardwareList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromHardwareList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromHardwareList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromHardwareList::Parameters::Input",
+ "properties": {
+ "hardwareObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessToReplicantFromIpAddressList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume. ",
+ "summary": "Remove access to this replica volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromIpAddressList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromIpAddressList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromIpAddressList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromIpAddressList::Parameters::Input",
+ "properties": {
+ "ipAddressObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessToReplicantFromSubnet": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnet/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromSubnet",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromSubnet::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromSubnet::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessToReplicantFromSubnetList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume. ",
+ "summary": "Remove access to this volume's replica from multiple SoftLayer_Network_Subnet objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnetList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromSubnetList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromSubnetList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromSubnetList::Parameters::Input",
+ "properties": {
+ "subnetObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessToReplicantFromVirtualGuestList": {
+ "post": {
+ "description": "This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume. ",
+ "summary": "Remove access to this volume's replica from multiple SoftLayer_Virtual_Guest objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromVirtualGuestList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromVirtualGuestList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromVirtualGuestList::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeAccessToReplicantFromVirtualGuestList::Parameters::Input",
+ "properties": {
+ "virtualGuestObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeCredential": {
+ "post": {
+ "description": "This method will remove a credential from the current volume. The credential must have been created using the 'addNewCredential' method. ",
+ "summary": "This method will remove a credential from the current volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeCredential/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::removeCredential",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeCredential::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::removeCredential::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/restoreFile": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Restore an individual file so that it may be used as it was before it was deleted. \n\nIf a file is deleted from a Virtual Server Storage account, the file is placed into the account's recycle bin and not permanently deleted. Therefore, restoreFile can be used to place the file back into your Virtual Server account's root directory. ",
+ "summary": "Restore access to an individual file in a Storage account.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFile/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::restoreFile",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::restoreFile::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::restoreFile::Parameters::Input",
+ "properties": {
+ "fileId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/restoreFromSnapshot": {
+ "post": {
+ "description": "Restore the volume from a snapshot that was previously taken. ",
+ "summary": "Restore from a volume snapshot.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFromSnapshot/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::restoreFromSnapshot",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::restoreFromSnapshot::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::restoreFromSnapshot::Parameters::Input",
+ "properties": {
+ "snapshotId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/sendPasswordReminderEmail": {
+ "post": {
+ "description": "The method will retrieve the password for the StorageLayer or Virtual Server Storage Account and email the password. The Storage Account passwords will be emailed to the master user. For Virtual Server Storage, the password will be sent to the email address used as the username. ",
+ "summary": "Email the password for the Storage account to the master user.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/sendPasswordReminderEmail/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::sendPasswordReminderEmail",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::sendPasswordReminderEmail::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::sendPasswordReminderEmail::Parameters::Input",
+ "properties": {
+ "username": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/setMountable": {
+ "post": {
+ "description": "Enable or disable the mounting of a Storage volume. When mounting is enabled the Storage volume will be mountable or available for use. \n\nFor Virtual Server volumes, disabling mounting will deny access to the Virtual Server Account, remove published material and deny all file interaction including uploads and downloads. \n\nEnabling or disabling mounting for Storage volumes is not possible if mounting has been disabled by SoftLayer or a parent account. ",
+ "summary": "Enable or disable mounting of a Storage volume.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/setMountable/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::setMountable",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::setMountable::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::setMountable::Parameters::Input",
+ "properties": {
+ "mountable": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/setSnapshotAllocation": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotAllocation/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::setSnapshotAllocation",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::setSnapshotAllocation::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::setSnapshotAllocation::Parameters::Input",
+ "properties": {
+ "capacityGb": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/setSnapshotNotification": {
+ "post": {
+ "description": "Function to enable/disable snapshot warning notification. ",
+ "summary": "Function to enable/disable snapshot warning notification.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotNotification/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::setSnapshotNotification",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "null"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::setSnapshotNotification::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::setSnapshotNotification::Parameters::Input",
+ "properties": {
+ "notificationFlag": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/upgradeVolumeCapacity": {
+ "post": {
+ "description": "Upgrade the Storage volume to one of the upgradable packages (for example from 10 Gigs of EVault storage to 100 Gigs of EVault storage). ",
+ "summary": "Edit the Storage volume to a different package",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/upgradeVolumeCapacity/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::upgradeVolumeCapacity",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::upgradeVolumeCapacity::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::upgradeVolumeCapacity::Parameters::Input",
+ "properties": {
+ "itemId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/uploadFile": {
+ "post": {
+ "description": "{{CloudLayerOnlyMethod}} Upload a file to a Storage account's root directory. Once uploaded, this method returns new file entity identifier for the upload file. \n\nThe following properties are required in the ''file'' parameter. \n*'''name''': The name of the file you wish to upload\n*'''content''': The raw contents of the file you wish to upload.\n*'''contentType''': The MIME-type of content that you wish to upload.",
+ "summary": "Upload a file to a Storage account's root directory.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/uploadFile/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::uploadFile",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::uploadFile::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::uploadFile::Parameters::Input",
+ "properties": {
+ "file": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/validateHostsAccess": {
+ "post": {
+ "description": "This method is used to validate if the hosts are behind gateway or not from [SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress] objects. This returns [SoftLayer_Container_Network_Storage_HostsGatewayInformation] object containing the host details along with a boolean attribute which indicates if it's behind the gateway or not. ",
+ "summary": "An API to check if the hosts provided are behind gateway or not from",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/validateHostsAccess/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::validateHostsAccess",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_HostsGatewayInformation"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::validateHostsAccess::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Backup_Evault::validateHostsAccess::Parameters::Input",
+ "properties": {
+ "hostObjectTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getCurrentCyclePeakUsage": {
+ "get": {
+ "description": "Peak number of bytes used in the vault for the current billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCurrentCyclePeakUsage/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getCurrentCyclePeakUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getPreviousCyclePeakUsage": {
+ "get": {
+ "description": "Peak number of bytes used in the vault for the previous billing cycle.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPreviousCyclePeakUsage/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getPreviousCyclePeakUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAccount": {
+ "get": {
+ "description": "The account that a Storage services belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAccountPassword": {
+ "get": {
+ "description": "Other usernames and passwords associated with a Storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccountPassword/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAccountPassword",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account_Password"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getActiveTransactions": {
+ "get": {
+ "description": "The currently active transactions on a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getActiveTransactions/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getActiveTransactions",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowDisasterRecoveryFailback": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailback/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowDisasterRecoveryFailback",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowDisasterRecoveryFailover": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailover/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowDisasterRecoveryFailover",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowedHardware": {
+ "get": {
+ "description": "The SoftLayer_Hardware objects which are allowed access to this storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowedHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowedIpAddresses": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowedIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowedReplicationHardware": {
+ "get": {
+ "description": "The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowedReplicationHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowedReplicationIpAddresses": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowedReplicationIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowedReplicationSubnets": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationSubnets/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowedReplicationSubnets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowedReplicationVirtualGuests": {
+ "get": {
+ "description": "The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationVirtualGuests/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowedReplicationVirtualGuests",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowedSubnets": {
+ "get": {
+ "description": "The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedSubnets/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowedSubnets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Subnet"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowedVirtualGuests": {
+ "get": {
+ "description": "The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedVirtualGuests/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getAllowedVirtualGuests",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getBillingItem": {
+ "get": {
+ "description": "The current billing item for a Storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItem/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getBillingItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Item"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getBillingItemCategory": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItemCategory/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getBillingItemCategory",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Category"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getBytesUsed": {
+ "get": {
+ "description": "The amount of space used by the volume, in bytes.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBytesUsed/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getBytesUsed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getCreationScheduleId": {
+ "get": {
+ "description": "The schedule id which was executed to create a snapshot.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCreationScheduleId/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getCreationScheduleId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getCredentials": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCredentials/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getCredentials",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getDailySchedule": {
+ "get": {
+ "description": "The Daily Schedule which is associated with this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDailySchedule/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getDailySchedule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getDependentDuplicate": {
+ "get": {
+ "description": "Whether or not a network storage volume is a dependent duplicate.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicate/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getDependentDuplicate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getDependentDuplicates": {
+ "get": {
+ "description": "The network storage volumes configured to be dependent duplicates of a volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicates/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getDependentDuplicates",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getEvents": {
+ "get": {
+ "description": "The events which have taken place on a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getEvents/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getEvents",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Event"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFailbackNotAllowed": {
+ "get": {
+ "description": "Determines whether the volume is allowed to failback",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailbackNotAllowed/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFailbackNotAllowed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFailoverNotAllowed": {
+ "get": {
+ "description": "Determines whether the volume is allowed to failover",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailoverNotAllowed/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFailoverNotAllowed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFileNetworkMountAddress": {
+ "get": {
+ "description": "Retrieves the NFS Network Mount Address Name for a given File Storage Volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileNetworkMountAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFileNetworkMountAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFixReplicationCurrentStatus": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFixReplicationCurrentStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getFixReplicationCurrentStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getHardware": {
+ "get": {
+ "description": "When applicable, the hardware associated with a Storage service.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardware/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getHardware",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getHasEncryptionAtRest": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHasEncryptionAtRest/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getHasEncryptionAtRest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getHourlySchedule": {
+ "get": {
+ "description": "The Hourly Schedule which is associated with this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHourlySchedule/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getHourlySchedule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIntervalSchedule": {
+ "get": {
+ "description": "The Interval Schedule which is associated with this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIntervalSchedule/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIntervalSchedule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIops": {
+ "get": {
+ "description": "The maximum number of IOPs selected for this volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIops/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIops",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIsConvertToIndependentTransactionInProgress": {
+ "get": {
+ "description": "Determines whether network storage volume has an active convert dependent clone to Independent transaction.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsConvertToIndependentTransactionInProgress/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIsConvertToIndependentTransactionInProgress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIsDependentDuplicateProvisionCompleted": {
+ "get": {
+ "description": "Determines whether dependent volume provision is completed on background.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsDependentDuplicateProvisionCompleted/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIsDependentDuplicateProvisionCompleted",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIsInDedicatedServiceResource": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsInDedicatedServiceResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIsInDedicatedServiceResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIsMagneticStorage": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsMagneticStorage/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIsMagneticStorage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIsProvisionInProgress": {
+ "get": {
+ "description": "Determines whether network storage volume has an active provision transaction.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsProvisionInProgress/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIsProvisionInProgress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIsReadyForSnapshot": {
+ "get": {
+ "description": "Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyForSnapshot/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIsReadyForSnapshot",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIsReadyToMount": {
+ "get": {
+ "description": "Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyToMount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIsReadyToMount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIscsiLuns": {
+ "get": {
+ "description": "Relationship between a container volume and iSCSI LUNs.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiLuns/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIscsiLuns",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIscsiReplicatingVolume": {
+ "get": {
+ "description": "The network storage volumes configured to be replicants of this volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiReplicatingVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIscsiReplicatingVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIscsiTargetIpAddresses": {
+ "get": {
+ "description": "Returns the target IP addresses of an iSCSI volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiTargetIpAddresses/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getIscsiTargetIpAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getLunId": {
+ "get": {
+ "description": "The ID of the LUN volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getLunId/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getLunId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getManualSnapshots": {
+ "get": {
+ "description": "The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getManualSnapshots/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getManualSnapshots",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getMetricTrackingObject": {
+ "get": {
+ "description": "A network storage volume's metric tracking object. This object records all periodic polled data available to this volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMetricTrackingObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getMetricTrackingObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getMountPath": {
+ "get": {
+ "description": "Retrieves the NFS Network Mount Path for a given File Storage Volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountPath/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getMountPath",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getMountableFlag": {
+ "get": {
+ "description": "Whether or not a network storage volume may be mounted.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountableFlag/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getMountableFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getMoveAndSplitStatus": {
+ "get": {
+ "description": "The current status of split or move operation as a part of volume duplication.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMoveAndSplitStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getMoveAndSplitStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getNotificationSubscribers": {
+ "get": {
+ "description": "The subscribers that will be notified for usage amount warnings and overages.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNotificationSubscribers/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getNotificationSubscribers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getOriginalSnapshotName": {
+ "get": {
+ "description": "The name of the snapshot that this volume was duplicated from.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalSnapshotName/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getOriginalSnapshotName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getOriginalVolumeId": {
+ "get": {
+ "description": "Volume id of the origin volume from which this volume is been cloned.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeId/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getOriginalVolumeId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getOriginalVolumeName": {
+ "get": {
+ "description": "The name of the volume that this volume was duplicated from.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeName/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getOriginalVolumeName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getOriginalVolumeSize": {
+ "get": {
+ "description": "The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeSize/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getOriginalVolumeSize",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getOsType": {
+ "get": {
+ "description": "A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsType/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getOsType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Iscsi_OS_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getOsTypeId": {
+ "get": {
+ "description": "A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsTypeId/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getOsTypeId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getParentPartnerships": {
+ "get": {
+ "description": "The volumes or snapshots partnered with a network storage volume in a parental role.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentPartnerships/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getParentPartnerships",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Partnership"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getParentVolume": {
+ "get": {
+ "description": "The parent volume of a volume in a complex storage relationship.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getParentVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getPartnerships": {
+ "get": {
+ "description": "The volumes or snapshots partnered with a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPartnerships/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getPartnerships",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Partnership"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getPermissionsGroups": {
+ "get": {
+ "description": "All permissions group(s) this volume is in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPermissionsGroups/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getPermissionsGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getProperties": {
+ "get": {
+ "description": "The properties used to provide additional details about a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProperties/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getProperties",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Property"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getProvisionedIops": {
+ "get": {
+ "description": "The number of IOPs provisioned for this volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProvisionedIops/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getProvisionedIops",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getReplicatingLuns": {
+ "get": {
+ "description": "The iSCSI LUN volumes being replicated by this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingLuns/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getReplicatingLuns",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getReplicatingVolume": {
+ "get": {
+ "description": "The network storage volume being replicated by a volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getReplicatingVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getReplicationEvents": {
+ "get": {
+ "description": "The volume replication events.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationEvents/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getReplicationEvents",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Event"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getReplicationPartners": {
+ "get": {
+ "description": "The network storage volumes configured to be replicants of a volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationPartners/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getReplicationPartners",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getReplicationSchedule": {
+ "get": {
+ "description": "The Replication Schedule associated with a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationSchedule/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getReplicationSchedule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getReplicationStatus": {
+ "get": {
+ "description": "The current replication status of a network storage volume. Indicates Failover or Failback status.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getReplicationStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSchedules": {
+ "get": {
+ "description": "The schedules which are associated with a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSchedules/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getSchedules",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getServiceResource": {
+ "get": {
+ "description": "The network resource a Storage service is connected to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getServiceResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getServiceResourceBackendIpAddress": {
+ "get": {
+ "description": "The IP address of a Storage resource.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceBackendIpAddress/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getServiceResourceBackendIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getServiceResourceName": {
+ "get": {
+ "description": "The name of a Storage's network resource.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceName/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getServiceResourceName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshotCapacityGb": {
+ "get": {
+ "description": "A volume's configured snapshot space size.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCapacityGb/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getSnapshotCapacityGb",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshotCreationTimestamp": {
+ "get": {
+ "description": "The creation timestamp of the snapshot on the storage platform.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCreationTimestamp/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getSnapshotCreationTimestamp",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshotDeletionThresholdPercentage": {
+ "get": {
+ "description": "The percentage of used snapshot space after which to delete automated snapshots.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotDeletionThresholdPercentage/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getSnapshotDeletionThresholdPercentage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshotNotificationStatus": {
+ "get": {
+ "description": "Whether or not a network storage volume may be mounted.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotNotificationStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getSnapshotNotificationStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshotSizeBytes": {
+ "get": {
+ "description": "The snapshot size in bytes.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSizeBytes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getSnapshotSizeBytes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshotSpaceAvailable": {
+ "get": {
+ "description": "A volume's available snapshot reservation space.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSpaceAvailable/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getSnapshotSpaceAvailable",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshots": {
+ "get": {
+ "description": "The snapshots associated with this SoftLayer_Network_Storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshots/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getSnapshots",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getStaasVersion": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStaasVersion/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getStaasVersion",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getStorageGroups": {
+ "get": {
+ "description": "The network storage groups this volume is attached to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroups/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getStorageGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getStorageTierLevel": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageTierLevel/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getStorageTierLevel",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getStorageType": {
+ "get": {
+ "description": "A description of the Storage object.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageType/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getStorageType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getTotalBytesUsed": {
+ "get": {
+ "description": "The amount of space used by the volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalBytesUsed/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getTotalBytesUsed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getTotalScheduleSnapshotRetentionCount": {
+ "get": {
+ "description": "The total snapshot retention count of all schedules on this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalScheduleSnapshotRetentionCount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getTotalScheduleSnapshotRetentionCount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getUsageNotification": {
+ "get": {
+ "description": "The usage notification for SL Storage services.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getUsageNotification/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getUsageNotification",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Notification"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getVendorName": {
+ "get": {
+ "description": "The type of network storage service.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVendorName/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getVendorName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getVirtualGuest": {
+ "get": {
+ "description": "When applicable, the virtual guest associated with a Storage service.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVirtualGuest/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getVirtualGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getVolumeHistory": {
+ "get": {
+ "description": "The username and password history for a Storage service.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeHistory/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getVolumeHistory",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_History"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getVolumeStatus": {
+ "get": {
+ "description": "The current status of a network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeStatus/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getVolumeStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getWebccAccount": {
+ "get": {
+ "description": "The account username and password for the EVault webCC interface.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebccAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getWebccAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account_Password"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getWeeklySchedule": {
+ "get": {
+ "description": "The Weekly Schedule which is associated with this network storage volume.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWeeklySchedule/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Backup_Evault::getWeeklySchedule",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Backup_EvaultID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Backup_Evault object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_DedicatedCluster/getDedicatedClusterList": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getDedicatedClusterList/"
+ },
+ "operationId": "SoftLayer_Network_Storage_DedicatedCluster::getDedicatedClusterList",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_DedicatedCluster/{SoftLayer_Network_Storage_DedicatedClusterID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Storage_DedicatedCluster record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_DedicatedCluster::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_DedicatedCluster"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_DedicatedClusterID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_DedicatedCluster object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_DedicatedCluster/{SoftLayer_Network_Storage_DedicatedClusterID}/getAccount": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_DedicatedCluster::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_DedicatedClusterID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_DedicatedCluster object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_DedicatedCluster/{SoftLayer_Network_Storage_DedicatedClusterID}/getServiceResource": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getServiceResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_DedicatedCluster::getServiceResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_DedicatedClusterID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_DedicatedCluster object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/addAllowedHost": {
+ "post": {
+ "description": "Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group. This will automatically enable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group. ",
+ "summary": "Attach a SoftLayer_Network_Storage_Allowed_Host object to this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/addAllowedHost/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::addAllowedHost",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::addAllowedHost::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::addAllowedHost::Parameters::Input",
+ "properties": {
+ "allowedHost": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/attachToVolume": {
+ "post": {
+ "description": "Use this method to attach a SoftLayer_Network_Storage volume to this group. This will automatically enable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group. ",
+ "summary": "Attach a SoftLayer_Network_Storage volume to this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/attachToVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::attachToVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::attachToVolume::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::attachToVolume::Parameters::Input",
+ "properties": {
+ "volume": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/createObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/deleteObject": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/getAllObjects": {
+ "get": {
+ "description": "Use this method to retrieve all network storage groups. ",
+ "summary": "Returns all network storage groups",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getNetworkConnectionDetails": {
+ "get": {
+ "description": "Use this method to retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects within this group. ",
+ "summary": "Retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects to connect to the Network Storage Volumes within this group ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/getNetworkConnectionDetails/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::getNetworkConnectionDetails",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_NetworkConnectionInformation"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Storage_Group record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/removeAllowedHost": {
+ "post": {
+ "description": "Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group. This will automatically disable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group. ",
+ "summary": "Remove a SoftLayer_Network_Storage_Allowed_Host object from this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/removeAllowedHost/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::removeAllowedHost",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::removeAllowedHost::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::removeAllowedHost::Parameters::Input",
+ "properties": {
+ "allowedHost": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/removeFromVolume": {
+ "post": {
+ "description": "Use this method to remove a SoftLayer_Network_Storage volume from this group. This will automatically disable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group. ",
+ "summary": "Remove a SoftLayer_Network_Storage volume from this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/removeFromVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::removeFromVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::removeFromVolume::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group::removeFromVolume::Parameters::Input",
+ "properties": {
+ "volume": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getAccount": {
+ "get": {
+ "description": "The SoftLayer_Account which owns this group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getAllowedHosts": {
+ "get": {
+ "description": "The allowed hosts list for this group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/getAllowedHosts/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::getAllowedHosts",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getAttachedVolumes": {
+ "get": {
+ "description": "The network storage volumes this group is attached to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/getAttachedVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::getAttachedVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getGroupType": {
+ "get": {
+ "description": "The type which defines this group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/getGroupType/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::getGroupType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getOsType": {
+ "get": {
+ "description": "The OS Type this group is configured for.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/getOsType/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::getOsType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Iscsi_OS_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getServiceResource": {
+ "get": {
+ "description": "The network resource this group is created on.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group/getServiceResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group::getServiceResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/addAllowedHost": {
+ "post": {
+ "description": "Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group. This will automatically enable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group. ",
+ "summary": "Attach a SoftLayer_Network_Storage_Allowed_Host object to this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/addAllowedHost/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::addAllowedHost",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::addAllowedHost::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::addAllowedHost::Parameters::Input",
+ "properties": {
+ "allowedHost": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/attachToVolume": {
+ "post": {
+ "description": "Use this method to attach a SoftLayer_Network_Storage volume to this group. This will automatically enable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group. ",
+ "summary": "Attach a SoftLayer_Network_Storage volume to this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/attachToVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::attachToVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::attachToVolume::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::attachToVolume::Parameters::Input",
+ "properties": {
+ "volume": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Storage_Group_Iscsi record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group_Iscsi"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/removeAllowedHost": {
+ "post": {
+ "description": "Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group. This will automatically disable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group. ",
+ "summary": "Remove a SoftLayer_Network_Storage_Allowed_Host object from this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeAllowedHost/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::removeAllowedHost",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::removeAllowedHost::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::removeAllowedHost::Parameters::Input",
+ "properties": {
+ "allowedHost": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/removeFromVolume": {
+ "post": {
+ "description": "Use this method to remove a SoftLayer_Network_Storage volume from this group. This will automatically disable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group. ",
+ "summary": "Remove a SoftLayer_Network_Storage volume from this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeFromVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::removeFromVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::removeFromVolume::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::removeFromVolume::Parameters::Input",
+ "properties": {
+ "volume": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/createObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/deleteObject": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Iscsi::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/getAllObjects": {
+ "get": {
+ "description": "Use this method to retrieve all network storage groups. ",
+ "summary": "Returns all network storage groups",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getNetworkConnectionDetails": {
+ "get": {
+ "description": "Use this method to retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects within this group. ",
+ "summary": "Retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects to connect to the Network Storage Volumes within this group ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getNetworkConnectionDetails/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::getNetworkConnectionDetails",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_NetworkConnectionInformation"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getAccount": {
+ "get": {
+ "description": "The SoftLayer_Account which owns this group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getAllowedHosts": {
+ "get": {
+ "description": "The allowed hosts list for this group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllowedHosts/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::getAllowedHosts",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getAttachedVolumes": {
+ "get": {
+ "description": "The network storage volumes this group is attached to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAttachedVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::getAttachedVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getGroupType": {
+ "get": {
+ "description": "The type which defines this group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getGroupType/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::getGroupType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getOsType": {
+ "get": {
+ "description": "The OS Type this group is configured for.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getOsType/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::getOsType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Iscsi_OS_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getServiceResource": {
+ "get": {
+ "description": "The network resource this group is created on.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getServiceResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Iscsi::getServiceResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_IscsiID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Iscsi object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/addAllowedHost": {
+ "post": {
+ "description": "Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group. This will automatically enable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group. ",
+ "summary": "Attach a SoftLayer_Network_Storage_Allowed_Host object to this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/addAllowedHost/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::addAllowedHost",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::addAllowedHost::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::addAllowedHost::Parameters::Input",
+ "properties": {
+ "allowedHost": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/attachToVolume": {
+ "post": {
+ "description": "Use this method to attach a SoftLayer_Network_Storage volume to this group. This will automatically enable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group. ",
+ "summary": "Attach a SoftLayer_Network_Storage volume to this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/attachToVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::attachToVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::attachToVolume::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::attachToVolume::Parameters::Input",
+ "properties": {
+ "volume": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Storage_Group_Nfs record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group_Nfs"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/removeAllowedHost": {
+ "post": {
+ "description": "Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group. This will automatically disable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group. ",
+ "summary": "Remove a SoftLayer_Network_Storage_Allowed_Host object from this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeAllowedHost/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::removeAllowedHost",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::removeAllowedHost::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::removeAllowedHost::Parameters::Input",
+ "properties": {
+ "allowedHost": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/removeFromVolume": {
+ "post": {
+ "description": "Use this method to remove a SoftLayer_Network_Storage volume from this group. This will automatically disable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group. ",
+ "summary": "Remove a SoftLayer_Network_Storage volume from this group",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeFromVolume/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::removeFromVolume",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::removeFromVolume::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::removeFromVolume::Parameters::Input",
+ "properties": {
+ "volume": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/createObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/createObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/deleteObject": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/deleteObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/editObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Group_Nfs::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/getAllObjects": {
+ "get": {
+ "description": "Use this method to retrieve all network storage groups. ",
+ "summary": "Returns all network storage groups",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getNetworkConnectionDetails": {
+ "get": {
+ "description": "Use this method to retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects within this group. ",
+ "summary": "Retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects to connect to the Network Storage Volumes within this group ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/getNetworkConnectionDetails/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::getNetworkConnectionDetails",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_NetworkConnectionInformation"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getAccount": {
+ "get": {
+ "description": "The SoftLayer_Account which owns this group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAccount/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getAllowedHosts": {
+ "get": {
+ "description": "The allowed hosts list for this group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllowedHosts/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::getAllowedHosts",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getAttachedVolumes": {
+ "get": {
+ "description": "The network storage volumes this group is attached to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAttachedVolumes/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::getAttachedVolumes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getGroupType": {
+ "get": {
+ "description": "The type which defines this group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/getGroupType/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::getGroupType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getOsType": {
+ "get": {
+ "description": "The OS Type this group is configured for.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/getOsType/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::getOsType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Iscsi_OS_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getServiceResource": {
+ "get": {
+ "description": "The network resource this group is created on.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Nfs/getServiceResource/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Nfs::getServiceResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_NfsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Nfs object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Type/getAllObjects": {
+ "get": {
+ "description": "Use this method to retrieve all storage group types available. ",
+ "summary": "Returns all storage group types available",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Type/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Type::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group_Type"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Group_Type/{SoftLayer_Network_Storage_Group_TypeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Network_Storage_Group_Type record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Group_Type/getObject/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Group_Type::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Group_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Group_TypeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Group_Type object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/credentialCreate": {
+ "get": {
+ "description": "Create credentials for an IBM Cloud Object Storage Account ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialCreate/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::credentialCreate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Hub_Cleversafe_AccountID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Hub_Cleversafe_Account object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/credentialDelete": {
+ "post": {
+ "description": "Delete a credential ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialDelete/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::credentialDelete",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::credentialDelete::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::credentialDelete::Parameters::Input",
+ "properties": {
+ "credential": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Hub_Cleversafe_AccountID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Hub_Cleversafe_Account object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Network_Storage_Hub_Cleversafe_Account"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getBuckets": {
+ "get": {
+ "description": "Get buckets ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBuckets/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getBuckets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Hub_Cleversafe_AccountID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Hub_Cleversafe_Account object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getCapacityUsage": {
+ "get": {
+ "description": "Returns the capacity usage for an IBM Cloud Object Storage account. ",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCapacityUsage/"
+ },
+ "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getCapacityUsage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Network_Storage_Hub_Cleversafe_AccountID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Network_Storage_Hub_Cleversafe_Account object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getCloudObjectStorageMetrics": {
+ "post": {
+ "description": "Makes a request to Cloud Object Storage metricsAPI service and when successful, returns an associative array with two elements: \n\nif 200: \n\n[ - SoftLayer_Network_Subnet_IpAddress
- SoftLayer_Hardware_Server
- SoftLayer_Virtual_Guest
- SoftLayer_Network_Vlan
- An entirely numeric value will be treated as a SoftLayer_Network_Subnet_IpAddress.id value of the desired IP address object.
- A dotted-quad IPv4 address.
- A full or compressed IPv6 address.
- An entirely numeric value will be treated as a SoftLayer_Network_Vlan.id value of the desired VLAN object.
- A semantic VLAN identifier of the form <data center short name>.<router>.<vlan number>, where < and > are literal, eg. dal13.fcr01.1234 - the router name may optionally contain the 'a' or 'b' redundancy qualifier (which has no meaning in this context).
- An entirely numeric value will be treated as a SoftLayer_Hardware_Server.id value of the desired server.
- A UUID corresponding to a server's SoftLayer_Hardware_Server.globalIdentifier.
- A value corresponding to a unique SoftLayer_Hardware_Server.hostname.
- A value corresponding to a unique fully-qualified domain name in the format 'hostname<domain>' where < and > are literal, e.g. myhost<mydomain.com>, hostname refers to SoftLayer_Hardware_Server.hostname and domain to SoftLayer_Hardware_Server.domain, respectively.
- An entirely numeric value will be treated as a SoftLayer_Virtual_Guest.id value of the desired server.
- A UUID corresponding to a server's SoftLayer_Virtual_Guest.globalIdentifier.
- A value corresponding to a unique SoftLayer_Virtual_Guest.hostname.
- A value corresponding to a unique fully-qualified domain name in the format 'hostname<domain>' where < and > are literal, e.g. myhost<mydomain.com>, hostname refers to SoftLayer_Virtual_Guest.hostname and domain to SoftLayer_Virtual_Guest.domain, respectively.
detailIdThe numeric ID of the [[SoftLayer_Account_Regional_Registry_Detail|detail]] object to relate.- Required
- Type - integer
registrationIdThe numeric ID of the [[SoftLayer_Network_Subnet_Registration|registration]] object to relate.- Required
- Type - integer
\n\n\n### VLAN Ordering\n\n```xml \n
\n\nThis service returns the same container that was provided, but with additional information that can be used for debugging or validation. It will also contain pricing information (prorated if applicable) for each of the products on the order. If an exception occurs during verification, a container with the
SoftLayer_Exception_Order exception type will be specified in the result.\n\n
verifyOrder accepts the same [[SoftLayer_Container_Product_Order]] as placeOrder, so see [[SoftLayer_Product_Order/placeOrder]] for more details. \n\n",
+ "summary": "Verify that an order may be successfully placed with the details provided.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/verifyOrder/"
+ },
+ "operationId": "SoftLayer_Product_Order::verifyOrder",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Product_Order"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Product_Order::verifyOrder::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Product_Order::verifyOrder::Parameters::Input",
+ "properties": {
+ "orderData": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Product_Order"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActiveItems": {
+ "get": {
+ "description": "Return a list of Items in the package with their active prices.",
+ "summary": "Retrieve the active items, as well as their prices and categories for this package",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getActiveItems/"
+ },
+ "operationId": "SoftLayer_Product_Package::getActiveItems",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/getActivePackagesByAttribute": {
+ "post": {
+ "description": "This method is deprecated and should not be used in production code. \n\nThis method will return the [[SoftLayer_Product_Package]] objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software filtered by an attribute type associated with the package. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [[SoftLayer_Product_Package/getCategories|getCategories]] or [[SoftLayer_Product_Package/getItems|getItems]] for more information. ",
+ "summary": "[DEPRECATED] Retrieve the active [[SoftLayer_Product_Package]] objects from which you can order a server, service or software filtered by an attribute type ([[SoftLayer_Product_Package_Attribute_Type]]) on the package. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getActivePackagesByAttribute/"
+ },
+ "operationId": "SoftLayer_Product_Package::getActivePackagesByAttribute",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getActivePackagesByAttribute::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getActivePackagesByAttribute::Parameters::Input",
+ "properties": {
+ "attributeKeyName": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Product_Package/getActivePrivateHostedCloudPackages": {
+ "get": {
+ "description": "[DEPRECATED] This method pulls all the active private hosted cloud packages. This will give you a basic description of the packages that are currently active and from which you can order private hosted cloud configurations. ",
+ "summary": "[DEPRECATED] Get the Active SoftLayer_Product_Packages from which one can order private hosted cloud configurations.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getActivePrivateHostedCloudPackages/"
+ },
+ "operationId": "SoftLayer_Product_Package::getActivePrivateHostedCloudPackages",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActiveUsageRatePrices": {
+ "post": {
+ "description": "This method returns a collection of active usage rate [[SoftLayer_Product_Item_Price]] objects for the current package and specified datacenter. Optionally you can retrieve the active usage rate prices for a particular [[SoftLayer_Product_Item_Category]] by specifying a category code as the first parameter. This information is useful so that you can see \"pay as you go\" rates (if any) for the current package, location and optionally category. ",
+ "summary": "Return the active usage rate prices for the current package. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getActiveUsageRatePrices/"
+ },
+ "operationId": "SoftLayer_Product_Package::getActiveUsageRatePrices",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getActiveUsageRatePrices::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getActiveUsageRatePrices::Parameters::Input",
+ "properties": {
+ "locationId": {
+ "type": "number"
+ },
+ "categoryCode": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/getAllObjects": {
+ "get": {
+ "description": "This method pulls all the active packages. This will give you a basic description of the packages that are currently active ",
+ "summary": "Get the Active SoftLayer_Product_Packages",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Product_Package::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/getAvailablePackagesForImageTemplate": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getAvailablePackagesForImageTemplate/"
+ },
+ "operationId": "SoftLayer_Product_Package::getAvailablePackagesForImageTemplate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getAvailablePackagesForImageTemplate::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getAvailablePackagesForImageTemplate::Parameters::Input",
+ "properties": {
+ "imageTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getCdnItems": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getCdnItems/"
+ },
+ "operationId": "SoftLayer_Product_Package::getCdnItems",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getCloudStorageItems": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getCloudStorageItems/"
+ },
+ "operationId": "SoftLayer_Product_Package::getCloudStorageItems",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getCloudStorageItems::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getCloudStorageItems::Parameters::Input",
+ "properties": {
+ "provider": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/getItemAvailabilityTypes": {
+ "get": {
+ "description": "Returns a collection of SoftLayer_Product_Item_Attribute_Type objects. These item attribute types specifically deal with when an item, SoftLayer_Product_Item, from the product catalog may no longer be available. The keynames for these attribute types start with 'UNAVAILABLE_AFTER_DATE_*', where the '*' may represent any string. For example, 'UNAVAILABLE_AFTER_DATE_NEW_ORDERS', signifies that the item is not available for new orders. There is a catch all attribute type, 'UNAVAILABLE_AFTER_DATE_ALL'. If an item has one of these availability attributes set, the value should be a valid date in MM/DD/YYYY, indicating the date after which the item will no longer be available. ",
+ "summary": "Returns a collection of SoftLayer_Product_Item_Attribute_Type objects.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getItemAvailabilityTypes/"
+ },
+ "operationId": "SoftLayer_Product_Package::getItemAvailabilityTypes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Attribute_Type"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItemPricesFromSoftwareDescriptions": {
+ "post": {
+ "description": "Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description ",
+ "summary": "Returns a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description that are available for the service offering (package). ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getItemPricesFromSoftwareDescriptions/"
+ },
+ "operationId": "SoftLayer_Product_Package::getItemPricesFromSoftwareDescriptions",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getItemPricesFromSoftwareDescriptions::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getItemPricesFromSoftwareDescriptions::Parameters::Input",
+ "properties": {
+ "softwareDescriptions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Software_Description"
+ }
+ },
+ "includeTranslationsFlag": {
+ "type": "boolean"
+ },
+ "returnAllPricesFlag": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItemsFromImageTemplate": {
+ "post": {
+ "description": "Return a collection of [[SoftLayer_Product_Item]] objects from a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] object",
+ "summary": "Return a collection of [[SoftLayer_Product_Item]] objects from a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] object",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getItemsFromImageTemplate/"
+ },
+ "operationId": "SoftLayer_Product_Package::getItemsFromImageTemplate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getItemsFromImageTemplate::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package::getItemsFromImageTemplate::Parameters::Input",
+ "properties": {
+ "imageTemplate": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getMessageQueueItems": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getMessageQueueItems/"
+ },
+ "operationId": "SoftLayer_Product_Package::getMessageQueueItems",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Product_Package record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getObject/"
+ },
+ "operationId": "SoftLayer_Product_Package::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getObjectStorageDatacenters": {
+ "get": {
+ "description": "This method will return a collection of [[SoftLayer_Container_Product_Order_Network_Storage_Hub_Datacenter]] objects which contain a datacenter location and all the associated active usage rate prices where object storage is available. This method is really only applicable to the object storage additional service package which has a [[SoftLayer_Product_Package_Type]] of '''ADDITIONAL_SERVICES_OBJECT_STORAGE'''. This information is useful so that you can see the \"pay as you go\" rates per datacenter. ",
+ "summary": "Returns a collection of datacenters where object storage is available plus the associated active usage rate prices. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getObjectStorageDatacenters/"
+ },
+ "operationId": "SoftLayer_Product_Package::getObjectStorageDatacenters",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Network_Storage_Hub_Datacenter"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getObjectStorageLocationGroups": {
+ "get": {
+ "description": "This method will return a collection of [[SoftLayer_Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup]] objects which contain a location group and all the associated active usage rate prices where object storage is available. This method is really only applicable to the object storage additional service package which has a [[SoftLayer_Product_Package_Type]] of '''ADDITIONAL_SERVICES_OBJECT_STORAGE'''. This information is useful so that you can see the \"pay as you go\" rates per location group. ",
+ "summary": "Returns a collection of location groups where object storage is available plus the associated active usage rate prices. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getObjectStorageLocationGroups/"
+ },
+ "operationId": "SoftLayer_Product_Package::getObjectStorageLocationGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getStandardCategories": {
+ "get": {
+ "description": "This call is similar to [[SoftLayer_Product_Package/getCategories|getCategories]], except that it does not include account-restricted pricing. Not all accounts have restricted pricing. ",
+ "summary": "This call is similar to [[SoftLayer_Product_Package/getCategories|getCategories]], except that it does not include account-restricted pricing. Not all accounts have restricted pricing. ",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getStandardCategories/"
+ },
+ "operationId": "SoftLayer_Product_Package::getStandardCategories",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Category"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getAccountRestrictedActivePresets": {
+ "get": {
+ "description": "The preset configurations available only for the authenticated account and this package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getAccountRestrictedActivePresets/"
+ },
+ "operationId": "SoftLayer_Product_Package::getAccountRestrictedActivePresets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getAccountRestrictedCategories": {
+ "get": {
+ "description": "The results from this call are similar to [[SoftLayer_Product_Package/getCategories|getCategories]], but these ONLY include account-restricted prices. Not all accounts have restricted pricing.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getAccountRestrictedCategories/"
+ },
+ "operationId": "SoftLayer_Product_Package::getAccountRestrictedCategories",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Category"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getAccountRestrictedPricesFlag": {
+ "get": {
+ "description": "The flag to indicate if there are any restricted prices in a package for the currently-active account.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getAccountRestrictedPricesFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getAccountRestrictedPricesFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActivePresets": {
+ "get": {
+ "description": "The available preset configurations for this package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getActivePresets/"
+ },
+ "operationId": "SoftLayer_Product_Package::getActivePresets",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActiveRamItems": {
+ "get": {
+ "description": "A collection of valid RAM items available for purchase in this package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getActiveRamItems/"
+ },
+ "operationId": "SoftLayer_Product_Package::getActiveRamItems",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActiveServerItems": {
+ "get": {
+ "description": "A collection of valid server items available for purchase in this package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getActiveServerItems/"
+ },
+ "operationId": "SoftLayer_Product_Package::getActiveServerItems",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActiveSoftwareItems": {
+ "get": {
+ "description": "A collection of valid software items available for purchase in this package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getActiveSoftwareItems/"
+ },
+ "operationId": "SoftLayer_Product_Package::getActiveSoftwareItems",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActiveUsagePrices": {
+ "get": {
+ "description": "A collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getActiveUsagePrices/"
+ },
+ "operationId": "SoftLayer_Product_Package::getActiveUsagePrices",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getAdditionalServiceFlag": {
+ "get": {
+ "description": "This flag indicates that the package is an additional service.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getAdditionalServiceFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getAdditionalServiceFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getAttributes": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getAttributes/"
+ },
+ "operationId": "SoftLayer_Product_Package::getAttributes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Attribute"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getAvailableLocations": {
+ "get": {
+ "description": "A collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]])",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getAvailableLocations/"
+ },
+ "operationId": "SoftLayer_Product_Package::getAvailableLocations",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Locations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getAvailableStorageUnits": {
+ "get": {
+ "description": "The maximum number of available disk storage units associated with the servers in a package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getAvailableStorageUnits/"
+ },
+ "operationId": "SoftLayer_Product_Package::getAvailableStorageUnits",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getCategories": {
+ "get": {
+ "description": "This is a collection of categories ([[SoftLayer_Product_Item_Category]]) associated with a package which can be used for ordering. These categories have several objects prepopulated which are useful when determining the available products for purchase. The categories contain groups ([[SoftLayer_Product_Package_Item_Category_Group]]) that organize the products and prices by similar features. For example, operating systems will be grouped by their manufacturer and virtual server disks will be grouped by their disk type (SAN vs. local). Each group will contain prices ([[SoftLayer_Product_Item_Price]]) which you can use determine the cost of each product. Each price has a product ([[SoftLayer_Product_Item]]) which provides the name and other useful information about the server, service or software you may purchase.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getCategories/"
+ },
+ "operationId": "SoftLayer_Product_Package::getCategories",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Category"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getConfiguration": {
+ "get": {
+ "description": "The item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getConfiguration/"
+ },
+ "operationId": "SoftLayer_Product_Package::getConfiguration",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Order_Configuration"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDefaultBootCategoryCode": {
+ "get": {
+ "description": "The default boot category code for the package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getDefaultBootCategoryCode/"
+ },
+ "operationId": "SoftLayer_Product_Package::getDefaultBootCategoryCode",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDefaultRamItems": {
+ "get": {
+ "description": "A collection of valid RAM items available for purchase in this package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getDefaultRamItems/"
+ },
+ "operationId": "SoftLayer_Product_Package::getDefaultRamItems",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeploymentNodeType": {
+ "get": {
+ "description": "The node type for a package in a solution deployment.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getDeploymentNodeType/"
+ },
+ "operationId": "SoftLayer_Product_Package::getDeploymentNodeType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeploymentPackages": {
+ "get": {
+ "description": "The packages that are allowed in a multi-server solution. (Deprecated)",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getDeploymentPackages/"
+ },
+ "operationId": "SoftLayer_Product_Package::getDeploymentPackages",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeploymentType": {
+ "get": {
+ "description": "The solution deployment type.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getDeploymentType/"
+ },
+ "operationId": "SoftLayer_Product_Package::getDeploymentType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeployments": {
+ "get": {
+ "description": "The package that represents a multi-server solution. (Deprecated)",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getDeployments/"
+ },
+ "operationId": "SoftLayer_Product_Package::getDeployments",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDisallowCustomDiskPartitions": {
+ "get": {
+ "description": "This flag indicates the package does not allow custom disk partitions.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getDisallowCustomDiskPartitions/"
+ },
+ "operationId": "SoftLayer_Product_Package::getDisallowCustomDiskPartitions",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getFirstOrderStep": {
+ "get": {
+ "description": "The Softlayer order step is optionally step-based. This returns the first SoftLayer_Product_Package_Order_Step in the step-based order process.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getFirstOrderStep/"
+ },
+ "operationId": "SoftLayer_Product_Package::getFirstOrderStep",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Order_Step"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getGatewayApplianceFlag": {
+ "get": {
+ "description": "Whether the package is a specialized network gateway appliance package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getGatewayApplianceFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getGatewayApplianceFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getGpuFlag": {
+ "get": {
+ "description": "This flag indicates that the package supports GPUs.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getGpuFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getGpuFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getHourlyBillingAvailableFlag": {
+ "get": {
+ "description": "Determines whether the package contains prices that can be ordered hourly.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getHourlyBillingAvailableFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getHourlyBillingAvailableFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getHourlyOnlyOrders": {
+ "get": {
+ "description": "Packages with this flag do not allow monthly orders.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getHourlyOnlyOrders/"
+ },
+ "operationId": "SoftLayer_Product_Package::getHourlyOnlyOrders",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItemConflicts": {
+ "get": {
+ "description": "The item-item conflicts associated with a package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getItemConflicts/"
+ },
+ "operationId": "SoftLayer_Product_Package::getItemConflicts",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Resource_Conflict"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItemLocationConflicts": {
+ "get": {
+ "description": "The item-location conflicts associated with a package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getItemLocationConflicts/"
+ },
+ "operationId": "SoftLayer_Product_Package::getItemLocationConflicts",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Resource_Conflict"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItemPriceReferences": {
+ "get": {
+ "description": "cross reference for item prices",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getItemPriceReferences/"
+ },
+ "operationId": "SoftLayer_Product_Package::getItemPriceReferences",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Item_Prices"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItemPrices": {
+ "get": {
+ "description": "A collection of SoftLayer_Product_Item_Prices that are valid for this package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getItemPrices/"
+ },
+ "operationId": "SoftLayer_Product_Package::getItemPrices",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItems": {
+ "get": {
+ "description": "A collection of valid items available for purchase in this package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getItems/"
+ },
+ "operationId": "SoftLayer_Product_Package::getItems",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getLocations": {
+ "get": {
+ "description": "A collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]])",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getLocations/"
+ },
+ "operationId": "SoftLayer_Product_Package::getLocations",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Location"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getLowestServerPrice": {
+ "get": {
+ "description": "The lowest server [[SoftLayer_Product_Item_Price]] related to this package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getLowestServerPrice/"
+ },
+ "operationId": "SoftLayer_Product_Package::getLowestServerPrice",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getMaximumPortSpeed": {
+ "get": {
+ "description": "The maximum available network speed associated with the package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getMaximumPortSpeed/"
+ },
+ "operationId": "SoftLayer_Product_Package::getMaximumPortSpeed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getMinimumPortSpeed": {
+ "get": {
+ "description": "The minimum available network speed associated with the package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getMinimumPortSpeed/"
+ },
+ "operationId": "SoftLayer_Product_Package::getMinimumPortSpeed",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getMongoDbEngineeredFlag": {
+ "get": {
+ "description": "This flag indicates that this is a MongoDB engineered package. (Deprecated)",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getMongoDbEngineeredFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getMongoDbEngineeredFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getNoUpgradesFlag": {
+ "get": {
+ "description": "Services ordered from this package cannot have upgrades or downgrades performed.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getNoUpgradesFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getNoUpgradesFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getNonEuCompliantFlag": {
+ "get": {
+ "description": "Whether the package is not in compliance with EU support.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getNonEuCompliantFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getNonEuCompliantFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getOrderPremiums": {
+ "get": {
+ "description": "The premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getOrderPremiums/"
+ },
+ "operationId": "SoftLayer_Product_Package::getOrderPremiums",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price_Premium"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPopLocationAvailabilityFlag": {
+ "get": {
+ "description": "This flag indicates if the package may be available in PoP locations in addition to Datacenters.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getPopLocationAvailabilityFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getPopLocationAvailabilityFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPreconfiguredFlag": {
+ "get": {
+ "description": "This flag indicates the package is pre-configured. (Deprecated)",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getPreconfiguredFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getPreconfiguredFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPresetConfigurationRequiredFlag": {
+ "get": {
+ "description": "Whether the package requires the user to define a preset configuration.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getPresetConfigurationRequiredFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getPresetConfigurationRequiredFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPreventVlanSelectionFlag": {
+ "get": {
+ "description": "Whether the package prevents the user from specifying a Vlan.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getPreventVlanSelectionFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getPreventVlanSelectionFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPrivateHostedCloudPackageFlag": {
+ "get": {
+ "description": "This flag indicates the package is for a private hosted cloud deployment. (Deprecated)",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getPrivateHostedCloudPackageFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPrivateHostedCloudPackageType": {
+ "get": {
+ "description": "The server role of the private hosted cloud deployment. (Deprecated)",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageType/"
+ },
+ "operationId": "SoftLayer_Product_Package::getPrivateHostedCloudPackageType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPrivateNetworkOnlyFlag": {
+ "get": {
+ "description": "Whether the package only has access to the private network.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getPrivateNetworkOnlyFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getPrivateNetworkOnlyFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getQuantaStorPackageFlag": {
+ "get": {
+ "description": "Whether the package is a specialized mass storage QuantaStor package. (Deprecated)",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getQuantaStorPackageFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getQuantaStorPackageFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getRaidDiskRestrictionFlag": {
+ "get": {
+ "description": "This flag indicates the package does not allow different disks with RAID.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getRaidDiskRestrictionFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getRaidDiskRestrictionFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getRedundantPowerFlag": {
+ "get": {
+ "description": "This flag determines if the package contains a redundant power supply product.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getRedundantPowerFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package::getRedundantPowerFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getRegions": {
+ "get": {
+ "description": "The regional locations that a package is available in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getRegions/"
+ },
+ "operationId": "SoftLayer_Product_Package::getRegions",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Location_Region"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getTopLevelItemCategoryCode": {
+ "get": {
+ "description": "The top level category code for this service offering.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getTopLevelItemCategoryCode/"
+ },
+ "operationId": "SoftLayer_Product_Package::getTopLevelItemCategoryCode",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getType": {
+ "get": {
+ "description": "The type of service offering. This property can be used to help filter packages.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package/getType/"
+ },
+ "operationId": "SoftLayer_Product_Package::getType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PackageID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/getAllObjects": {
+ "get": {
+ "description": "This method returns all the active package presets.",
+ "summary": "Get all active package presets",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Product_Package_Preset record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getObject/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getAvailableStorageUnits": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getAvailableStorageUnits/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getAvailableStorageUnits",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getBareMetalReservedFlag": {
+ "get": {
+ "description": "When true this preset is for ordering a Bare Metal Reserved server.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getBareMetalReservedFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getBareMetalReservedFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getCategories": {
+ "get": {
+ "description": "The item categories that are included in this package preset configuration.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getCategories/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getCategories",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Category"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getComputeGroup": {
+ "get": {
+ "description": "The compute family this configuration belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getComputeGroup/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getComputeGroup",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Server_Group"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getConfiguration": {
+ "get": {
+ "description": "The preset configuration (category and price).",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getConfiguration/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getConfiguration",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset_Configuration"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getDisallowedComputeGroupUpgradeFlag": {
+ "get": {
+ "description": "When true this preset is only allowed to upgrade/downgrade to other presets in the same compute family.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getDisallowedComputeGroupUpgradeFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getDisallowedComputeGroupUpgradeFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getFixedConfigurationFlag": {
+ "get": {
+ "description": "A package preset with this flag set will not allow the price's defined in the preset configuration to be overriden during order placement.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getFixedConfigurationFlag/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getFixedConfigurationFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getLocations": {
+ "get": {
+ "description": "The locations this preset configuration is available in. If empty the preset is available in all locations the package is available in.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getLocations/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getLocations",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Location"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getLowestPresetServerPrice": {
+ "get": {
+ "description": "The lowest server prices related to this package preset.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getLowestPresetServerPrice/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getLowestPresetServerPrice",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getPackage": {
+ "get": {
+ "description": "The package this preset belongs to.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getPackage/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getPackage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getPackageConfiguration": {
+ "get": {
+ "description": "The item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getPackageConfiguration/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getPackageConfiguration",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Order_Configuration"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getPrices": {
+ "get": {
+ "description": "The item prices that are included in this package preset configuration.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getPrices/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getPrices",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getStorageGroupTemplateArrays": {
+ "get": {
+ "description": "Describes how all disks in this preset will be configured.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getStorageGroupTemplateArrays/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getStorageGroupTemplateArrays",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group_Template_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getTotalMinimumHourlyFee": {
+ "get": {
+ "description": "The starting hourly price for this configuration. Additional options not defined in the preset may increase the cost.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumHourlyFee/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getTotalMinimumHourlyFee",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getTotalMinimumRecurringFee": {
+ "get": {
+ "description": "The starting monthly price for this configuration. Additional options not defined in the preset may increase the cost.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumRecurringFee/"
+ },
+ "operationId": "SoftLayer_Product_Package_Preset::getTotalMinimumRecurringFee",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_PresetID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Preset object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Server/getAllObjects": {
+ "get": {
+ "description": "This method will grab all the package servers. ",
+ "summary": "Get the package servers",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Server/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Product_Package_Server::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Server"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Product_Package_Server record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Server/getObject/"
+ },
+ "operationId": "SoftLayer_Product_Package_Server::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Server"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_ServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Server object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getCatalog": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Server/getCatalog/"
+ },
+ "operationId": "SoftLayer_Product_Package_Server::getCatalog",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Catalog"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_ServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Server object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getItem": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Server/getItem/"
+ },
+ "operationId": "SoftLayer_Product_Package_Server::getItem",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_ServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Server object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getItemPrice": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Server/getItemPrice/"
+ },
+ "operationId": "SoftLayer_Product_Package_Server::getItemPrice",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Item_Price"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_ServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Server object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getPackage": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Server/getPackage/"
+ },
+ "operationId": "SoftLayer_Product_Package_Server::getPackage",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_ServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Server object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getPreset": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Server/getPreset/"
+ },
+ "operationId": "SoftLayer_Product_Package_Server::getPreset",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_ServerID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Server object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Server_Option/getAllOptions": {
+ "get": {
+ "description": "This method will grab all the package server options. ",
+ "summary": "Get all the package server options",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Server_Option/getAllOptions/"
+ },
+ "operationId": "SoftLayer_Product_Package_Server_Option::getAllOptions",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Server_Option"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Server_Option/{SoftLayer_Product_Package_Server_OptionID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Product_Package_Server_Option record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Server_Option/getObject/"
+ },
+ "operationId": "SoftLayer_Product_Package_Server_Option::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Server_Option"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_Server_OptionID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Server_Option object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Server_Option/getOptions": {
+ "post": {
+ "description": "This method will grab all the package server options for the specified type. ",
+ "summary": "Get all the package server options of a particular type",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Server_Option/getOptions/"
+ },
+ "operationId": "SoftLayer_Product_Package_Server_Option::getOptions",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Server_Option"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package_Server_Option::getOptions::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Product_Package_Server_Option::getOptions::Parameters::Input",
+ "properties": {
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Product_Package_Type/getAllObjects": {
+ "get": {
+ "description": "This method will return all of the available package types. ",
+ "summary": "Get all the package types.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Type/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Product_Package_Type::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Type"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Type/{SoftLayer_Product_Package_TypeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Product_Package_Type record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Type/getObject/"
+ },
+ "operationId": "SoftLayer_Product_Package_Type::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_TypeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Type object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Package_Type/{SoftLayer_Product_Package_TypeID}/getPackages": {
+ "get": {
+ "description": "All the packages associated with the given package type.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Package_Type/getPackages/"
+ },
+ "operationId": "SoftLayer_Product_Package_Type::getPackages",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Package"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Package_TypeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Package_Type object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Promotion/findByPromoCode": {
+ "post": {
+ "description": "Retrieves a promotion using its code.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Promotion/findByPromoCode/"
+ },
+ "operationId": "SoftLayer_Product_Promotion::findByPromoCode",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Product_Promotion"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Product_Promotion::findByPromoCode::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Product_Promotion::findByPromoCode::Parameters::Input",
+ "properties": {
+ "code": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Product_Promotion/{SoftLayer_Product_PromotionID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Product_Promotion record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Promotion/getObject/"
+ },
+ "operationId": "SoftLayer_Product_Promotion::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Promotion"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_PromotionID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Promotion object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/approveChanges": {
+ "get": {
+ "description": "When a change is made to an upgrade by Sales, this method will approve the changes that were made. A customer must acknowledge the change and approve it so that the upgrade request can proceed. ",
+ "summary": "Approves the upgrade request order that was revised by SoftLayer Sales",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/approveChanges/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::approveChanges",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getObject": {
+ "get": {
+ "description": "getObject retrieves a SoftLayer_Product_Upgrade_Request object on your account whose ID corresponds to the ID of the init parameter passed to the SoftLayer_Product_Upgrade_Request service. ",
+ "summary": "Retrieve a SoftLayer_Product_Upgrade_Request record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/getObject/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Upgrade_Request"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/updateMaintenanceWindow": {
+ "post": {
+ "description": "In case an upgrade cannot be performed, the maintenance window needs to be updated to a future date. ",
+ "summary": "Updates the maintenance window",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/updateMaintenanceWindow/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::updateMaintenanceWindow",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Product_Upgrade_Request::updateMaintenanceWindow::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Product_Upgrade_Request::updateMaintenanceWindow::Parameters::Input",
+ "properties": {
+ "maintenanceStartTime": {
+ "type": "string"
+ },
+ "maintenanceWindowId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getAccount": {
+ "get": {
+ "description": "The account that an order belongs to",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/getAccount/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getCompletedFlag": {
+ "get": {
+ "description": "Indicates that the upgrade request has completed or has been cancelled.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/getCompletedFlag/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::getCompletedFlag",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getInvoice": {
+ "get": {
+ "description": "This is the invoice associated with the upgrade request. For hourly servers or services, an invoice will not be available.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/getInvoice/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::getInvoice",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Invoice"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getOrder": {
+ "get": {
+ "description": "An order record associated to the upgrade request",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/getOrder/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::getOrder",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Billing_Order"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getServer": {
+ "get": {
+ "description": "A server object associated with the upgrade request if any.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/getServer/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::getServer",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Hardware"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getStatus": {
+ "get": {
+ "description": "The current status of the upgrade request.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/getStatus/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::getStatus",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Product_Upgrade_Request_Status"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getTicket": {
+ "get": {
+ "description": "The ticket that is used to coordinate the upgrade process.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/getTicket/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::getTicket",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Ticket"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getUser": {
+ "get": {
+ "description": "The user that placed the order.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/getUser/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::getUser",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_User_Customer"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getVirtualGuest": {
+ "get": {
+ "description": "A virtual server object associated with the upgrade request if any.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Upgrade_Request/getVirtualGuest/"
+ },
+ "operationId": "SoftLayer_Product_Upgrade_Request::getVirtualGuest",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Virtual_Guest"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Product_Upgrade_RequestID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Product_Upgrade_Request object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Hook/createObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Hook/createObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Hook::createObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Hook"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Hook::createObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Hook::createObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Hook"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Provisioning_Hook/{SoftLayer_Provisioning_HookID}/deleteObject": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Hook/deleteObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Hook::deleteObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_HookID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Hook object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Hook/{SoftLayer_Provisioning_HookID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Hook/editObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Hook::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Hook::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Hook::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Hook"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_HookID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Hook object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Hook/{SoftLayer_Provisioning_HookID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Provisioning_Hook record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Hook/getObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Hook::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Hook"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_HookID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Hook object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Hook/{SoftLayer_Provisioning_HookID}/getAccount": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Hook/getAccount/"
+ },
+ "operationId": "SoftLayer_Provisioning_Hook::getAccount",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Account"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_HookID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Hook object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Hook/{SoftLayer_Provisioning_HookID}/getHookType": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Hook/getHookType/"
+ },
+ "operationId": "SoftLayer_Provisioning_Hook::getHookType",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Hook_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_HookID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Hook object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Hook_Type/getAllHookTypes": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Hook_Type/getAllHookTypes/"
+ },
+ "operationId": "SoftLayer_Provisioning_Hook_Type::getAllHookTypes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Hook_Type"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Hook_Type/{SoftLayer_Provisioning_Hook_TypeID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Provisioning_Hook_Type record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Hook_Type/getObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Hook_Type::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Hook_Type"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Hook_TypeID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Hook_Type object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassification": {
+ "post": {
+ "description": "Retrieve an array of SoftLayer_Provisioning_Maintenance_Classification data types, which contain all maintenance classifications. ",
+ "summary": "Retrieve a maintenance classification.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassification/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Classification::getMaintenanceClassification",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Classification"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Classification::getMaintenanceClassification::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Classification::getMaintenanceClassification::Parameters::Input",
+ "properties": {
+ "maintenanceClassificationId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassificationsByItemCategory": {
+ "get": {
+ "description": "Retrieve an array of SoftLayer_Provisioning_Maintenance_Classification data types, which contain all maintenance classifications. ",
+ "summary": "Retrieve all maintenance classifications.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassificationsByItemCategory/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Classification::getMaintenanceClassificationsByItemCategory",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Classification_Item_Category"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Classification/{SoftLayer_Provisioning_Maintenance_ClassificationID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Provisioning_Maintenance_Classification record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Classification::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Classification"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Maintenance_ClassificationID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Maintenance_Classification object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Classification/{SoftLayer_Provisioning_Maintenance_ClassificationID}/getItemCategories": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getItemCategories/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Classification::getItemCategories",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Classification_Item_Category"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Maintenance_ClassificationID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Maintenance_Classification object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/{SoftLayer_Provisioning_Maintenance_Classification_Item_CategoryID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Provisioning_Maintenance_Classification_Item_Category record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Classification_Item_Category::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Classification_Item_Category"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Maintenance_Classification_Item_CategoryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Maintenance_Classification_Item_Category object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/{SoftLayer_Provisioning_Maintenance_Classification_Item_CategoryID}/getMaintenanceClassification": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getMaintenanceClassification/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Classification_Item_Category::getMaintenanceClassification",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Classification"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Maintenance_Classification_Item_CategoryID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Maintenance_Classification_Item_Category object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Slots/{SoftLayer_Provisioning_Maintenance_SlotsID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Provisioning_Maintenance_Slots record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Slots/getObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Slots::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Slots"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Maintenance_SlotsID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Maintenance_Slots object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Ticket/{SoftLayer_Provisioning_Maintenance_TicketID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Provisioning_Maintenance_Ticket record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Ticket::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Ticket"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Maintenance_TicketID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Maintenance_Ticket object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Ticket/{SoftLayer_Provisioning_Maintenance_TicketID}/getAvailableSlots": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getAvailableSlots/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Ticket::getAvailableSlots",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Slots"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Maintenance_TicketID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Maintenance_Ticket object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Ticket/{SoftLayer_Provisioning_Maintenance_TicketID}/getMaintenanceClass": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getMaintenanceClass/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Ticket::getMaintenanceClass",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Classification"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Maintenance_TicketID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Maintenance_Ticket object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Ticket/{SoftLayer_Provisioning_Maintenance_TicketID}/getTicket": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getTicket/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Ticket::getTicket",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Ticket"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Maintenance_TicketID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Maintenance_Ticket object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Window/addCustomerUpgradeWindow": {
+ "post": {
+ "description": "getMaintenceWindowForTicket() returns a boolean ",
+ "summary": "Updates or creates records in the",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Window/addCustomerUpgradeWindow/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Window::addCustomerUpgradeWindow",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::addCustomerUpgradeWindow::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::addCustomerUpgradeWindow::Parameters::Input",
+ "properties": {
+ "customerUpgradeWindow": {
+ "$ref": "#/components/schemas/SoftLayer_Container_Provisioning_Maintenance_Window"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceClassifications": {
+ "get": {
+ "description": "Returns all the maintenance classifications. ",
+ "summary": "Returns the maintenance classifications",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceClassifications/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceClassifications",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Classification"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceStartEndTime": {
+ "post": {
+ "description": "getMaintenanceStartEndTime() returns a specific maintenance window ",
+ "summary": "Returns a specific maintenance window",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceStartEndTime/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceStartEndTime",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Window"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceStartEndTime::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceStartEndTime::Parameters::Input",
+ "properties": {
+ "ticketId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowForTicket": {
+ "post": {
+ "description": "Returns a specific maintenance window. ",
+ "summary": "Returns a specific maintenance window",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowForTicket/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindowForTicket",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Window"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindowForTicket::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindowForTicket::Parameters::Input",
+ "properties": {
+ "maintenanceWindowId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowTicketsByTicketId": {
+ "post": {
+ "description": "getMaintenanceWindowTicketsByTicketId() returns a list maintenance window ticket records by ticket id ",
+ "summary": "Returns maintenance window ticket",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowTicketsByTicketId/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindowTicketsByTicketId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Ticket"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindowTicketsByTicketId::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindowTicketsByTicketId::Parameters::Input",
+ "properties": {
+ "ticketId": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindows": {
+ "post": {
+ "description": "This method returns a list of available maintenance windows ",
+ "summary": "Returns available maintenance windows",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindows/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindows",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Window"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindows::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindows::Parameters::Input",
+ "properties": {
+ "beginDate": {
+ "type": "string"
+ },
+ "endDate": {
+ "type": "string"
+ },
+ "locationId": {
+ "type": "number"
+ },
+ "slotsNeeded": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Provisioning_Maintenance_Window/getMaintenceWindows": {
+ "post": {
+ "description": "(DEPRECATED) Use [[SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindows|getMaintenanceWindows]] method. ",
+ "summary": "Returns available maintenance windows",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenceWindows/"
+ },
+ "operationId": "SoftLayer_Provisioning_Maintenance_Window::getMaintenceWindows",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Maintenance_Window"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::getMaintenceWindows::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Provisioning_Maintenance_Window::getMaintenceWindows::Parameters::Input",
+ "properties": {
+ "beginDate": {
+ "type": "string"
+ },
+ "endDate": {
+ "type": "string"
+ },
+ "locationId": {
+ "type": "number"
+ },
+ "slotsNeeded": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/SoftLayer_Provisioning_Version1_Transaction_Group/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Provisioning_Version1_Transaction_Group::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Version1_Transaction_Group/{SoftLayer_Provisioning_Version1_Transaction_GroupID}/getObject": {
+ "get": {
+ "description": "getObject retrieves the SoftLayer_Provisioning_Version1_Transaction_Group object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Provisioning_Version1_Transaction_Group service. ",
+ "summary": "Retrieve a SoftLayer_Provisioning_Version1_Transaction_Group record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Version1_Transaction_Group::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_Group"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Version1_Transaction_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Version1_Transaction_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Version1_Transaction_OrderTracking/{SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Provisioning_Version1_Transaction_OrderTracking record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Version1_Transaction_OrderTracking/getObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Version1_Transaction_OrderTracking::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_OrderTracking"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Version1_Transaction_OrderTracking object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Version1_Transaction_OrderTracking/{SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID}/getInvoiceId": {
+ "get": {
+ "description": "Invoice ID",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Version1_Transaction_OrderTracking/getInvoiceId/"
+ },
+ "operationId": "SoftLayer_Provisioning_Version1_Transaction_OrderTracking::getInvoiceId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Version1_Transaction_OrderTracking object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Version1_Transaction_OrderTracking/{SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID}/getOrderTrackingState": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Version1_Transaction_OrderTracking/getOrderTrackingState/"
+ },
+ "operationId": "SoftLayer_Provisioning_Version1_Transaction_OrderTracking::getOrderTrackingState",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Version1_Transaction_OrderTracking object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Version1_Transaction_OrderTracking/{SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID}/getTransaction": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Version1_Transaction_OrderTracking/getTransaction/"
+ },
+ "operationId": "SoftLayer_Provisioning_Version1_Transaction_OrderTracking::getTransaction",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Version1_Transaction_OrderTracking object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState/{SoftLayer_Provisioning_Version1_Transaction_OrderTrackingStateID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState/getObject/"
+ },
+ "operationId": "SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Provisioning_Version1_Transaction_OrderTrackingStateID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Configuration/{SoftLayer_Resource_ConfigurationID}/setOsPasswordFromEncrypted": {
+ "post": {
+ "description": "The setOsPasswordFromEncrypted method is used to set the operating system password from a key/pair encrypted password signed by SoftLayer. ",
+ "summary": "Set resource operating system password from an encrypted password",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Configuration/setOsPasswordFromEncrypted/"
+ },
+ "operationId": "SoftLayer_Resource_Configuration::setOsPasswordFromEncrypted",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Resource_Configuration::setOsPasswordFromEncrypted::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Resource_Configuration::setOsPasswordFromEncrypted::Parameters::Input",
+ "properties": {
+ "encryptedPassword": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_ConfigurationID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Configuration object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/editObject": {
+ "post": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group/editObject/"
+ },
+ "operationId": "SoftLayer_Resource_Group::editObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Resource_Group::editObject::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Resource_Group::editObject::Parameters::Input",
+ "properties": {
+ "templateObject": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Resource_Group record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group/getObject/"
+ },
+ "operationId": "SoftLayer_Resource_Group::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getAncestorGroups": {
+ "get": {
+ "description": "A resource group's associated group ancestors.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group/getAncestorGroups/"
+ },
+ "operationId": "SoftLayer_Resource_Group::getAncestorGroups",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getAttributes": {
+ "get": {
+ "description": "A resource group's associated attributes.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group/getAttributes/"
+ },
+ "operationId": "SoftLayer_Resource_Group::getAttributes",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group_Attribute"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getHardwareMembers": {
+ "get": {
+ "description": "A resource group's associated hardware members.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group/getHardwareMembers/"
+ },
+ "operationId": "SoftLayer_Resource_Group::getHardwareMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group_Member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getMembers": {
+ "get": {
+ "description": "A resource group's associated members.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group/getMembers/"
+ },
+ "operationId": "SoftLayer_Resource_Group::getMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group_Member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getRootResourceGroup": {
+ "get": {
+ "description": "A resource group's associated root resource group.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group/getRootResourceGroup/"
+ },
+ "operationId": "SoftLayer_Resource_Group::getRootResourceGroup",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getSubnetMembers": {
+ "get": {
+ "description": "A resource group's associated subnet members.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group/getSubnetMembers/"
+ },
+ "operationId": "SoftLayer_Resource_Group::getSubnetMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group_Member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getTemplate": {
+ "get": {
+ "description": "A resource group's associated template.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group/getTemplate/"
+ },
+ "operationId": "SoftLayer_Resource_Group::getTemplate",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group_Template"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getVlanMembers": {
+ "get": {
+ "description": "A resource group's associated VLAN members.",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group/getVlanMembers/"
+ },
+ "operationId": "SoftLayer_Resource_Group::getVlanMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group_Member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_GroupID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group_Template/getAllObjects": {
+ "get": {
+ "description": null,
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group_Template/getAllObjects/"
+ },
+ "operationId": "SoftLayer_Resource_Group_Template::getAllObjects",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group_Template"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group_Template/{SoftLayer_Resource_Group_TemplateID}/getObject": {
+ "get": {
+ "description": null,
+ "summary": "Retrieve a SoftLayer_Resource_Group_Template record.",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group_Template/getObject/"
+ },
+ "operationId": "SoftLayer_Resource_Group_Template::getObject",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group_Template"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_Group_TemplateID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group_Template object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group_Template/{SoftLayer_Resource_Group_TemplateID}/getChildren": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group_Template/getChildren/"
+ },
+ "operationId": "SoftLayer_Resource_Group_Template::getChildren",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group_Template"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_Group_TemplateID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group_Template object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Group_Template/{SoftLayer_Resource_Group_TemplateID}/getMembers": {
+ "get": {
+ "description": "",
+ "summary": "",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Group_Template/getMembers/"
+ },
+ "operationId": "SoftLayer_Resource_Group_Template::getMembers",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SoftLayer_Resource_Group_Template_Member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_Group_TemplateID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Group_Template object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getAccountId": {
+ "get": {
+ "description": "The getAccountId retrieves the ID for the account on which the resource is located.",
+ "summary": "The id for the account which the resource is in",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getAccountId/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getAccountId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getBackendMacAddresses": {
+ "get": {
+ "description": "The getBackendMacAddresses method retrieves a list of backend MAC addresses for the resource",
+ "summary": "A list of backend MAC addresses",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getBackendMacAddresses/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getBackendMacAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getDatacenter": {
+ "get": {
+ "description": "The getDatacenter method retrieves the name of the datacenter in which the resource is located.",
+ "summary": "The name for the datacenter which the resource is in",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getDatacenter/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getDatacenter",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getDatacenterId": {
+ "get": {
+ "description": "The getDatacenterId retrieves the ID for the datacenter in which the resource is located.",
+ "summary": "The id for the datacenter which the resource is in",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getDatacenterId/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getDatacenterId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getDomain": {
+ "get": {
+ "description": "The getDomain method retrieves the hostname for the resource.",
+ "summary": "A resource's domain",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getDomain/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getDomain",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getFrontendMacAddresses": {
+ "get": {
+ "description": "The getFrontendMacAddresses method retrieves a list of frontend MAC addresses for the resource",
+ "summary": "A list of frontend MAC addresses",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getFrontendMacAddresses/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getFrontendMacAddresses",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getFullyQualifiedDomainName": {
+ "get": {
+ "description": "The getFullyQualifiedDomainName method provides the user with a combined return which includes the hostname and domain for the resource. Because this method returns multiple pieces of information, it avoids the need to use multiple methods to return the desired information. ",
+ "summary": "A resource's fully qualified domain name",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getFullyQualifiedDomainName/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getFullyQualifiedDomainName",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getGlobalIdentifier": {
+ "get": {
+ "description": "The getId getGlobalIdentifier retrieves the globalIdentifier for the resource",
+ "summary": "A resource's globalIdentifier",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getGlobalIdentifier/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getGlobalIdentifier",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getHostname": {
+ "get": {
+ "description": "The getHostname method retrieves the hostname for the resource.",
+ "summary": "A resource's hostname",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getHostname/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getHostname",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getId": {
+ "get": {
+ "description": "The getId method retrieves the ID for the resource",
+ "summary": "A resource's id",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getId/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getId",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getPrimaryBackendIpAddress": {
+ "get": {
+ "description": "The getPrimaryBackendIpAddress method retrieves the primary backend IP address for the resource",
+ "summary": "The primary backend IP address for the resource",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getPrimaryBackendIpAddress/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getPrimaryBackendIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getPrimaryIpAddress": {
+ "get": {
+ "description": "The getPrimaryIpAddress method retrieves the primary IP address for the resource. For resources with a frontend network, the frontend IP address will be returned. For resources that have been provisioned with only a backend network, the backend IP address will be returned, as a frontend address will not exist. ",
+ "summary": "The primary IP address for the resource",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getPrimaryIpAddress/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getPrimaryIpAddress",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getProvisionState": {
+ "get": {
+ "description": "The getProvisionState method retrieves the provision state of the resource. The provision state may be used to determine when it is considered safe to perform additional setup operations. The method returns 'PROCESSING' to indicate the provision is in progress and 'COMPLETE' when the provision is complete. ",
+ "summary": "Obtain the provision state for a resource",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getProvisionState/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getProvisionState",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getRouter": {
+ "post": {
+ "description": "The getRouter method will return the router associated with a network component. When the router is redundant, the hostname of the redundant group will be returned, rather than the router hostname. ",
+ "summary": "The router associated with a network component",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getRouter/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getRouter",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Resource_Metadata::getRouter::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Resource_Metadata::getRouter::Parameters::Input",
+ "properties": {
+ "macAddress": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getServiceResource": {
+ "post": {
+ "description": "The getServiceResource method retrieves a specific service resource associated with the resource. Service resources are additional resources that may be used by this resource. ",
+ "summary": "Obtain a specific service resource associated with the resource",
+ "externalDocs": {
+ "description": "SLDN Documentation",
+ "url": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getServiceResource/"
+ },
+ "operationId": "SoftLayer_Resource_Metadata::getServiceResource",
+ "responses": {
+ "200": {
+ "description": "Successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ],
+ "requestBody": {
+ "description": "POST parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "SoftLayer_Resource_Metadata::getServiceResource::Parameters",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "title": "SoftLayer_Resource_Metadata::getServiceResource::Parameters::Input",
+ "properties": {
+ "serviceName": {
+ "type": "string"
+ },
+ "index": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "SoftLayer_Resource_MetadataID",
+ "in": "path",
+ "description": "ID for a SoftLayer_Resource_Metadata object",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ }
+ },
+ "/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getServiceResources": {
+ "get": {
+ "description": "The getServiceResources method retrieves all service resources associated with the resource. Service resources are additional resources that may be used by this resource. The output format is _objectType: quantifier in search strings. See the documentation for the [[SoftLayer_Search/search]] method on how to restrict searches using object types. \n\nThe advancedSearch() method recognizes [[SoftLayer_Container_Search_ObjectType_Property]], which can also be used to limit searches. Example: \n\n_objectType:Type_1 propertyA:value \n\nA search string can specify multiple properties, separated with spaces. Example: \n\n_objectType:Type_1 propertyA:value propertyB:value \n\nA collection of available object types and their properties can be retrieved by calling the [[SoftLayer_Search/getObjectTypes]] method. \n\n\n#### Exact Match on Text Fields\nTo enforce an exact match on text fields, encapsulate the term in double quotes. For example, given a set of device host names: \n\n- baremetal-a
- baremetal-b
- a-virtual-guest
- b-virtual-guest
- edge-router
_objectType: quantifier in search strings. This quantifier can be used to restrict a search to specific object types. Example usage: \n\n_objectType:Type_1 (other search terms...) \n\nA search string can specify multiple object types, separated by commas (no spaces are permitted between the type names). Example: \n\n_objectType:Type_1,Type_2,Type_3 (other search terms...) \n\nIf the list of object types is prefixed with a hyphen or minus sign (-), then the specified types are excluded from the search. Example: \n\n_objectType:-Type_4,Type_5 (other search terms...) \n\nA collection of available object types can be retrieved by calling the [[SoftLayer_Search/getObjectTypes]] method. \n\n\n#### Exact Match on Text Fields\nTo enforce an exact match on text fields, encapsulate the term in double quotes. For example, given a set of device host names: \n\n- baremetal-a
- baremetal-b
- a-virtual-guest
- b-virtual-guest
- edge-router
Example
\nWarning: If you remove the EU Supported account flag, you are removing the restriction that limits Processing activities to EU personnel.
", + "docOverview": "Turn off the EU Supported account flag.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_AccessDenied", + "description": "Throws an access denied error if the user making the call does not have sufficient permissions." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws an error if the account is not in an eligible support tier." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Account", + "method": "enableEuSupport" + } + ], + "static": true + }, + "disableVpnConfigRequiresVpnManageAttribute": { + "name": "disableVpnConfigRequiresVpnManageAttribute", + "type": "void", + "doc": "Disables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account. If the attribute does not exist for the account, it will be created and set to false. ", + "docOverview": "Disable the VPN Config Requires VPN Manage attribute, creating it if necessary.", + "static": true + }, + "editAccount": { + "name": "editAccount", + "type": "SoftLayer_Container_Account_Update_Response", + "doc": "This method will edit the account's information. Pass in a SoftLayer_Account template with the fields to be modified. Certain changes to the account will automatically create a ticket for manual review. This will be returned with the SoftLayer_Container_Account_Update_Response.The following fields are editable:
- companyName
- firstName
- lastName
- address1
- address2
- city
- state
- country
- postalCode
- officePhone
- alternatePhone
- faxPhone
- abuseEmails.email
- billingInfo.vatId
If you select the EU Supported option, the most common Support issues will be limited to IBM Cloud staff located in the EU. In the event your issue requires non-EU expert assistance, it will be reviewed and approval given prior to any non-EU intervention. Additionally, in order to support and update the services, cross-border Processing of your data may still occur. Please ensure you take the necessary actions to allow this Processing, as detailed in the Cloud Service Terms. A standard Data Processing Addendum is available here.
\n\nImportant note (you will only see this once): Orders using the API will proceed without additional notifications. The terms related to selecting products, services, or locations outside the EU apply to API orders. Users you create and API keys you generate will have the ability to order products, services, and locations outside of the EU. It is your responsibility to educate anyone you grant access to your account on the consequences and requirements if they make a selection that is not in the EU Supported option. In order to meet EU Supported requirements, the current PPTP VPN solution will no longer be offered or supported.
\n\nIf PPTP has been selected as an option for any users in your account by itself (or in combination with another VPN offering), you will need to disable PPTP before selecting the EU Supported account feature. For more information on VPN changes, click here.
", + "docOverview": "Turn on the EU Supported account flag.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_AccessDenied", + "description": "Throws an access denied error if the user making the call does not have sufficient permissions." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws an error if the account is not in an eligible support tier." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Account", + "method": "disableEuSupport" + } + ], + "static": true + }, + "enableVpnConfigRequiresVpnManageAttribute": { + "name": "enableVpnConfigRequiresVpnManageAttribute", + "type": "void", + "doc": "Enables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account. If the attribute does not exist for the account, it will be created and set to true. ", + "docOverview": "Enable the VPN Config Requires VPN Manage attribute, creating it if necessary.", + "static": true + }, + "getAccountBackupHistory": { + "name": "getAccountBackupHistory", + "type": "SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails", + "typeArray": true, + "doc": "This method returns an array of SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails objects for the given start and end dates. Start and end dates should be be valid ISO 8601 dates. The backupStatus can be one of null, 'success', 'failed', or 'conflict'. The 'success' backupStatus returns jobs with a status of 'COMPLETED', the 'failed' backupStatus returns jobs with a status of 'FAILED', while the 'conflict' backupStatus will return jobs that are not 'COMPLETED' or 'FAILED'. ", + "docOverview": "This method provides a history of account backups.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "<<< EOT Thrown if there was an error while" + } + ], + "parameters": [ + { + "name": "startDate", + "type": "dateTime", + "doc": "Timestamp of the starting date" + }, + { + "name": "endDate", + "type": "dateTime", + "doc": "Timestamp of the ending date" + }, + { + "name": "backupStatus", + "type": "string", + "doc": "$backupStatus Can be null, 'success', 'failed', or 'conflict'", + "defaultValue": null + } + ], + "static": true + }, + "getAccountTraitValue": { + "name": "getAccountTraitValue", + "type": "string", + "doc": "This method pulls an account trait by its key. ", + "docOverview": "Get the specific trait by its key", + "parameters": [ + { + "name": "keyName", + "type": "string" + } + ], + "static": true + }, + "getActiveOutletPackages": { + "name": "getActiveOutletPackages", + "type": "SoftLayer_Product_Package", + "typeArray": true, + "doc": "This is deprecated and will not return any results. ", + "docOverview": "DEPRECATED. This method will return nothing.", + "maskable": true, + "deprecated": true, + "static": true + }, + "getActivePackages": { + "name": "getActivePackages", + "type": "SoftLayer_Product_Package", + "typeArray": true, + "doc": "This method will return the [[SoftLayer_Product_Package]] objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [[SoftLayer_Product_Package/getCategories|getCategories]] or [[SoftLayer_Product_Package/getItems|getItems]] for more information. \n\nPackages that have been retired will not appear in this result set. ", + "docOverview": "Retrieve the active [[SoftLayer_Product_Package]] objects from which you can order a server, service or software. ", + "maskable": true, + "static": true + }, + "getActivePackagesByAttribute": { + "name": "getActivePackagesByAttribute", + "type": "SoftLayer_Product_Package", + "typeArray": true, + "doc": "This method is deprecated and should not be used in production code. \n\nThis method will return the [[SoftLayer_Product_Package]] objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software filtered by an attribute type associated with the package. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [[SoftLayer_Product_Package/getCategories|getCategories]] or [[SoftLayer_Product_Package/getItems|getItems]] for more information. ", + "docOverview": "[DEPRECATED] Retrieve the active [[SoftLayer_Product_Package]] objects from which you can order a server, service or software filtered by an attribute type ([[SoftLayer_Product_Package_Attribute_Type]]) on the package. ", + "docAssociatedMethods": [ + { + "service": "SoftLayer_Product_Package", + "method": "getActivePackagesByAttribute" + } + ], + "maskable": true, + "deprecated": true, + "parameters": [ + { + "name": "attributeKeyName", + "type": "string", + "doc": "the attribute key name" + } + ], + "static": true + }, + "getActivePrivateHostedCloudPackages": { + "name": "getActivePrivateHostedCloudPackages", + "type": "SoftLayer_Product_Package", + "typeArray": true, + "doc": "[DEPRECATED] This method pulls all the active private hosted cloud packages. This will give you a basic description of the packages that are currently active and from which you can order private hosted cloud configurations. ", + "maskable": true, + "deprecated": true, + "static": true + }, + "getAlternateCreditCardData": { + "name": "getAlternateCreditCardData", + "type": "SoftLayer_Container_Account_Payment_Method_CreditCard", + "static": true + }, + "getAttributeByType": { + "name": "getAttributeByType", + "type": "SoftLayer_Account_Attribute", + "doc": "Retrieve a single [[SoftLayer_Account_Attribute]] record by its [[SoftLayer_Account_Attribute_Type|types's]] key name. ", + "docOverview": "Retrieve an account attribute by type key name.", + "docAssociatedMethods": [ + { + "service": "SoftLayer_Account", + "method": "hasAttribute" + }, + { + "service": "SoftLayer_Account", + "method": "getAttributes" + } + ], + "maskable": true, + "parameters": [ + { + "name": "attributeType", + "type": "string", + "doc": "The [[SoftLayer_Account_Attribute_Type]] key name associated with the account attribute you wish to retrieve." + } + ], + "static": true + }, + "getAuxiliaryNotifications": { + "name": "getAuxiliaryNotifications", + "type": "SoftLayer_Container_Utility_Message", + "typeArray": true, + "static": true, + "limitable": true + }, + "getAverageArchiveUsageMetricDataByDate": { + "name": "getAverageArchiveUsageMetricDataByDate", + "type": "float", + "doc": "Returns the average disk space usage for all archive repositories. ", + "docOverview": "Returns the average disk usage for all archive repositories for the timeframe based on the parameters provided. ", + "parameters": [ + { + "name": "startDateTime", + "type": "dateTime", + "doc": "datetime of the start date of the graph" + }, + { + "name": "endDateTime", + "type": "dateTime", + "doc": "datetime of the ending date of the graph" + } + ], + "static": true + }, + "getAveragePublicUsageMetricDataByDate": { + "name": "getAveragePublicUsageMetricDataByDate", + "type": "float", + "doc": "Returns the average disk space usage for all public repositories. ", + "docOverview": "Returns the average disk usage for all public repositories for the timeframe based on the parameters provided. ", + "parameters": [ + { + "name": "startDateTime", + "type": "dateTime", + "doc": "datetime of the start date of the graph" + }, + { + "name": "endDateTime", + "type": "dateTime", + "doc": "datetime of the ending date of the graph" + } + ], + "static": true + }, + "getBandwidthList": { + "name": "getBandwidthList", + "type": "SoftLayer_Container_Bandwidth_Usage", + "typeArray": true, + "parameters": [ + { + "name": "networkType", + "type": "string", + "doc": "Specify either the public or private network", + "defaultValue": "public" + }, + { + "name": "direction", + "type": "string", + "doc": "Specify either in or out usage", + "defaultValue": "out" + }, + { + "name": "startDate", + "type": "string", + "doc": "Beginning of cycle to sum usage", + "defaultValue": null + }, + { + "name": "endDate", + "type": "string", + "doc": "Beginning of cycle to sum usage", + "defaultValue": null + }, + { + "name": "serverIds", + "type": "int", + "typeArray": true, + "doc": "Integer array of specific server IDs", + "defaultValue": [] + } + ], + "static": true + }, + "getCurrentUser": { + "name": "getCurrentUser", + "type": "SoftLayer_User_Customer", + "doc": "Retrieve the user record of the user calling the SoftLayer API. ", + "docOverview": "Retrieve the current API user's record.", + "static": true, + "maskable": true + }, + "getDedicatedHostsForImageTemplate": { + "name": "getDedicatedHostsForImageTemplate", + "type": "SoftLayer_Virtual_DedicatedHost", + "typeArray": true, + "doc": "This returns a collection of dedicated hosts that are valid for a given image template. ", + "docOverview": "Get a collection of dedicated hosts that are valid for a given image template. ", + "maskable": true, + "parameters": [ + { + "name": "imageTemplateId", + "type": "int", + "doc": "A [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] id to get dedicated hosts for" + } + ], + "static": true + }, + "getFlexibleCreditProgramInfo": { + "name": "getFlexibleCreditProgramInfo", + "type": "SoftLayer_Container_Account_Discount_Program", + "doc": "[DEPRECATED] Please use SoftLayer_Account::getFlexibleCreditProgramsInfo. \n\nThis method will return a [[SoftLayer_Container_Account_Discount_Program]] object containing the Flexible Credit Program information for this account. To be considered an active participant, the account must have an enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false. Please note that all discount amount entries are reported as pre-tax amounts and the legacy tax fields in the [[SoftLayer_Container_Account_Discount_Program]] are deprecated. ", + "docOverview": "[DEPRECATED] Please use SoftLayer_Account::getFlexibleCreditProgramsInfo. This is no longer an accurate representation of discounts. ", + "docAssociatedMethods": [ + { + "service": "SoftLayer_Account", + "method": "getFlexibleCreditProgramsInfo" + } + ], + "deprecated": true, + "parameters": [ + { + "name": "forNextBillCycle", + "type": "boolean", + "doc": "<<< EOT", + "defaultValue": false + } + ], + "static": true + }, + "getFlexibleCreditProgramsInfo": { + "name": "getFlexibleCreditProgramsInfo", + "type": "SoftLayer_Container_Account_Discount_Program_Collection", + "doc": "This method will return a [[SoftLayer_Container_Account_Discount_Program_Collection]] object containing information on all of the Flexible Credit Programs your account is enrolled in. To be considered an active participant, the account must have at least one enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program_Collection object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false. Please note that all discount amount entries are reported as pre-tax amounts. ", + "docOverview": "This method retrieves information on all of your Flexible Credit Program enrollments for your account. ", + "docAssociatedMethods": [ + { + "service": "SoftLayer_Product_Order", + "method": "verifyOrder" + } + ], + "parameters": [ + { + "name": "nextBillingCycleFlag", + "type": "boolean", + "doc": "Flag indicating whether the information in the container should be in the next bill cycle.", + "defaultValue": false + } + ], + "static": true + }, + "getHardwarePools": { + "name": "getHardwarePools", + "type": "SoftLayer_Container_Hardware_Pool_Details", + "typeArray": true, + "doc": "Return a collection of managed hardware pools.", + "docOverview": "Get a collection of managed hardware pools.", + "static": true + }, + "getLargestAllowedSubnetCidr": { + "name": "getLargestAllowedSubnetCidr", + "type": "int", + "doc": "Computes the number of available public secondary IP addresses, aligned to a subnet size. ", + "docOverview": "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. \n\n0 is returned if an overflow is detected. \n\nThe use of $locationId has been deprecated. ", + "parameters": [ + { + "name": "numberOfHosts", + "type": "int", + "doc": "Number of hosts to adjust the current server count by", + "defaultValue": 1 + }, + { + "name": "locationId", + "type": "int", + "doc": "Deprecated", + "defaultValue": 3 + } + ], + "static": true + }, + "getNetAppActiveAccountLicenseKeys": { + "name": "getNetAppActiveAccountLicenseKeys", + "type": "string", + "typeArray": true, + "doc": "This returns a collection of active NetApp software account license keys.", + "docOverview": "Get a collection of active NetApp software account license keys.", + "static": true + }, + "getNextInvoiceExcel": { + "name": "getNextInvoiceExcel", + "type": "base64Binary", + "doc": "Return an account's next invoice in a Microsoft excel format. The \"next invoice\" is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.", + "docOverview": "Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.", + "parameters": [ + { + "name": "documentCreateDate", + "type": "dateTime", + "doc": "Retrieves Excel on file created after this date. (optional)", + "defaultValue": null + } + ], + "static": true + }, + "getNextInvoicePdf": { + "name": "getNextInvoicePdf", + "type": "base64Binary", + "doc": "Return an account's next invoice in PDF format. The \"next invoice\" is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.", + "docOverview": "Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.", + "parameters": [ + { + "name": "documentCreateDate", + "type": "dateTime", + "doc": "Retrieves PDF on file created after this date. (optional)", + "defaultValue": null + } + ], + "static": true + }, + "getNextInvoicePdfDetailed": { + "name": "getNextInvoicePdfDetailed", + "type": "base64Binary", + "doc": "Return an account's next invoice detailed portion in PDF format. The \"next invoice\" is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.", + "docOverview": "Retrieve the next billing period's detailed invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account.", + "parameters": [ + { + "name": "documentCreateDate", + "type": "dateTime", + "doc": "Retrieves PDF Details on file created after this date. (optional)", + "defaultValue": null + } + ], + "static": true + }, + "getNextInvoiceZeroFeeItemCounts": { + "name": "getNextInvoiceZeroFeeItemCounts", + "type": "SoftLayer_Container_Product_Item_Category_ZeroFee_Count", + "typeArray": true, + "static": true + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account", + "doc": "getObject retrieves the SoftLayer_Account object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Account service. You can only retrieve the account that your portal user is assigned to. ", + "docOverview": "Retrieve a SoftLayer_Account record.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_ObjectNotFound", + "description": "Throw the error \"Unable to find object with id of {id}.\" if the given initialization parameter has an invalid id field." + }, + { + "exception": "SoftLayer_Exception_AccessDenied", + "description": "Throw the error \"Access Denied.\" if the given initialization parameter id field is not the account id of the user making the API call." + } + ], + "filterable": true, + "maskable": true, + "static": true + }, + "getPendingCreditCardChangeRequestData": { + "name": "getPendingCreditCardChangeRequestData", + "type": "SoftLayer_Container_Account_Payment_Method_CreditCard", + "typeArray": true, + "doc": "Before being approved for general use, a credit card must be approved by a SoftLayer agent. Once a credit card change request has been either approved or denied, the change request will no longer appear in the list of pending change requests. This method will return a list of all pending change requests as well as a portion of the data from the original request. ", + "docOverview": "Retrieve details of all credit card change requests which have not been processed by a SoftLayer agent.", + "static": true + }, + "getReferralPartnerCommissionForecast": { + "name": "getReferralPartnerCommissionForecast", + "type": "SoftLayer_Container_Referral_Partner_Commission", + "typeArray": true, + "static": true + }, + "getReferralPartnerCommissionHistory": { + "name": "getReferralPartnerCommissionHistory", + "type": "SoftLayer_Container_Referral_Partner_Commission", + "typeArray": true, + "static": true + }, + "getReferralPartnerCommissionPending": { + "name": "getReferralPartnerCommissionPending", + "type": "SoftLayer_Container_Referral_Partner_Commission", + "typeArray": true, + "static": true + }, + "getSharedBlockDeviceTemplateGroups": { + "name": "getSharedBlockDeviceTemplateGroups", + "type": "SoftLayer_Virtual_Guest_Block_Device_Template_Group", + "typeArray": true, + "doc": "This method returns the [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] objects that have been shared with this account ", + "docOverview": "Get the collection of template group objects that have been shared with this account.", + "limitable": true, + "filterable": true, + "maskable": true, + "static": true + }, + "getTechIncubatorProgramInfo": { + "name": "getTechIncubatorProgramInfo", + "type": "SoftLayer_Container_Account_Discount_Program", + "doc": "This method will return a SoftLayer_Container_Account_Discount_Program object containing the Technology Incubator Program information for this account. To be considered an active participant, the account must have an enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false. ", + "docOverview": "This method retrieves the Technology Incubator Program information for your account. ", + "docAssociatedMethods": [ + { + "service": "SoftLayer_Product_Order", + "method": "verifyOrder" + } + ], + "parameters": [ + { + "name": "forNextBillCycle", + "type": "boolean", + "doc": "Boolean flag to indicate whether the information in the container should be in", + "defaultValue": false + } + ], + "static": true + }, + "getThirdPartyPoliciesAcceptanceStatus": { + "name": "getThirdPartyPoliciesAcceptanceStatus", + "type": "SoftLayer_Container_Policy_Acceptance", + "typeArray": true, + "doc": "Returns multiple [[SoftLayer_Container_Policy_Acceptance]] that represent the acceptance status of the applicable third-party policies for this account. ", + "docOverview": "Get the acceptance status of the applicable third-party policies.", + "static": true + }, + "getValidSecurityCertificateEntries": { + "name": "getValidSecurityCertificateEntries", + "type": "SoftLayer_Security_Certificate_Entry", + "typeArray": true, + "doc": "Retrieve a list of valid (non-expired) security certificates without the sensitive certificate information. This allows non-privileged users to view and select security certificates when configuring associated services. ", + "static": true + }, + "getVmWareActiveAccountLicenseKeys": { + "name": "getVmWareActiveAccountLicenseKeys", + "type": "string", + "typeArray": true, + "doc": "This returns a collection of active VMware software account license keys.", + "docOverview": "Get a collection of active VMware software account license keys.", + "static": true + }, + "getWindowsUpdateStatus": { + "name": "getWindowsUpdateStatus", + "type": "SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status", + "typeArray": true, + "doc": "Retrieve a list of an account's hardware's Windows Update status. This list includes which servers have available updates, which servers require rebooting due to updates, which servers have failed retrieving updates, and which servers have failed to communicate with the SoftLayer private Windows Software Update Services server. ", + "docOverview": "Retrieve a list of an account's hardware's Windows Update status.", + "docErrorHandling": [ + { + "exception": "SoftLayer", + "description": "Exception Throw the exception \"No servers found for this user.\" if the user making the API call does not have access to any of their account's hardware." + }, + { + "exception": "SoftLayer", + "description": "Exception Throw the exception \"No Windows-based servers found for this user.\" if the user making the API call does not have access to hardware that runs the Microsoft Windows operating system." + }, + { + "exception": "SoftLayer", + "description": "Exception Throw the exception \"Filed to get a response from {address}.\" if the API is unable to contact the rrivate WSUS servers." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Hardware", + "method": "getWindowsUpdateStatus" + } + ], + "static": true + }, + "hasAttribute": { + "name": "hasAttribute", + "type": "boolean", + "doc": "Determine if an account has an [[SoftLayer_Account_Attribute|attribute]] associated with it. hasAttribute() returns false if the attribute does not exist or if it does not have a value. ", + "docOverview": "Determine if an account has a given attribute.", + "docAssociatedMethods": [ + { + "service": "SoftLayer_Account", + "method": "getAttributeByType" + }, + { + "service": "SoftLayer_Account", + "method": "getAttributes" + } + ], + "parameters": [ + { + "name": "attributeType", + "type": "string", + "doc": "The [[SoftLayer_Account_Attribute_Type]] key name associated with the account attribute you wish to determine exists." + } + ], + "static": true + }, + "hourlyInstanceLimit": { + "name": "hourlyInstanceLimit", + "type": "int", + "doc": "This method will return the limit (number) of hourly services the account is allowed to have. ", + "docOverview": "Retrieve the number of hourly services that an account is allowed to have ", + "static": true + }, + "hourlyServerLimit": { + "name": "hourlyServerLimit", + "type": "int", + "doc": "This method will return the limit (number) of hourly bare metal servers the account is allowed to have. ", + "docOverview": "Retrieve the number of hourly bare metal servers that an account is allowed to have ", + "static": true + }, + "initiatePayerAuthentication": { + "name": "initiatePayerAuthentication", + "type": "SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup", + "doc": "Initiates Payer Authentication and provides data that is required for payer authentication enrollment and device data collection. ", + "docOverview": "Initiate Payer Authentication", + "parameters": [ + { + "name": "setupInformation", + "type": "SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup_Information" + } + ], + "static": true + }, + "isActiveVmwareCustomer": { + "name": "isActiveVmwareCustomer", + "type": "boolean", + "docOverview": "Determines if the account is considered an active VMware customer and as such eligible to order VMware restricted products. This result is cached for up to 60 seconds. ", + "static": true + }, + "isEligibleForLocalCurrencyProgram": { + "name": "isEligibleForLocalCurrencyProgram", + "type": "boolean", + "doc": "Returns true if this account is eligible for the local currency program, false otherwise. ", + "static": true + }, + "isEligibleToLinkWithPaas": { + "name": "isEligibleToLinkWithPaas", + "type": "boolean", + "doc": "Returns true if this account is eligible to link with PaaS. False otherwise. ", + "docOverview": "Returns true if this account is eligible to link with PaaS. False otherwise. ", + "static": true + }, + "linkExternalAccount": { + "name": "linkExternalAccount", + "type": "void", + "doc": "This method will link this SoftLayer account with the provided external account. ", + "docOverview": "This method will link this SoftLayer account with the provided external account. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws if a link between either of the accounts already exists." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws , 'Unable to authenticate request.' if authentication of the request fails." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws , 'Unable to link external account to SoftLayer account.', if the attempt to link the accounts fails." + } + ], + "parameters": [ + { + "name": "externalAccountId", + "type": "string", + "doc": "The ID of the external account to link to this SoftLayer account" + }, + { + "name": "authorizationToken", + "type": "string", + "doc": "Access token for any authorization that needs to happen" + }, + { + "name": "externalServiceProviderKey", + "type": "string", + "doc": "Key name of the service provider" + } + ], + "static": true + }, + "removeAlternateCreditCard": { + "name": "removeAlternateCreditCard", + "type": "boolean", + "static": true + }, + "requestCreditCardChange": { + "name": "requestCreditCardChange", + "type": "SoftLayer_Billing_Payment_Card_ChangeRequest", + "doc": "Retrieve the record data associated with the submission of a Credit Card Change Request. Softlayer customers are permitted to request a change in Credit Card information. Part of the process calls for an attempt by SoftLayer to submit at $1.00 charge to the financial institution backing the credit card as a means of verifying that the information provided in the change request is valid. The data associated with this change request returned to the calling function. \n\nIf the onlyChangeNicknameFlag parameter is set to true, the nickname of the credit card will be changed immediately without requiring approval by an agent. To change the nickname of the active payment method, pass the empty string for paymentRoleName. To change the nickname for the alternate credit card, pass ALTERNATE_CREDIT_CARD as the paymentRoleName. vatId must be set, but the value will not be used and the empty string is acceptable. ", + "docOverview": "Retrieve the record data associated with the submission of a Credit Card Change Request.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Billing_Payment_Card_PayerAuthenticationRequired", + "description": "Throw the error \"The customer is enrolled in payer authentication. Authenticate the cardholder before continuing with the transaction. ACSUrl={access control server url} | PAReq={payer authentication request message} | TransactionID={Transaction ID}\" occurs when payer authentication is required. The error message contains additional applicable data to support continuation of authentication via Cardinal Cruise Hybrid. You must take the ACSUrl, PAReq, and TransactionID and include them in the Cardinal.continue function in order to proceed with the authentication session. NOTE: In the Cardinal.continue function, the 'Payload' field value should be populated with the data from PAReq." + } + ], + "maskable": true, + "parameters": [ + { + "name": "request", + "type": "SoftLayer_Billing_Payment_Card_ChangeRequest", + "doc": "Details required to request a credit card change." + }, + { + "name": "vatId", + "type": "string", + "doc": "EU member states VAT ID." + }, + { + "name": "paymentRoleName", + "type": "string", + "doc": "keyName of the card's payment role", + "defaultValue": null + }, + { + "name": "onlyChangeNicknameFlag", + "type": "boolean", + "defaultValue": false + } + ], + "static": true + }, + "requestManualPayment": { + "name": "requestManualPayment", + "type": "SoftLayer_Billing_Payment_Card_ManualPayment", + "doc": "Retrieve the record data associated with the submission of a Manual Payment Request. Softlayer customers are permitted to request a manual one-time payment at a minimum amount of $2.00. Customers may submit a Credit Card Payment (Mastercard, Visa, American Express) or a PayPal payment. For Credit Card Payments, SoftLayer engages the credit card financial institution to submit the payment request. The financial institution's response and other data associated with the transaction are returned to the calling function. In the case of PayPal Payments, SoftLayer engages the PayPal system to initiate the PayPal payment sequence. The applicable data generated during the request is returned to the calling function. ", + "docOverview": "Retrieve the record data associated with the submission of a Manual Payment Request.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Billing_Payment_Card_PayerAuthenticationRequired", + "description": "Throw the error \"The customer is enrolled in payer authentication. Authenticate the cardholder before continuing with the transaction. ACSUrl={access control server url} | PAReq={payer authentication request message} | TransactionID={Transaction ID}\" occurs when payer authentication is required. The error message contains additional applicable data to support continuation of authentication via Cardinal Cruise Hybrid. You must take the ACSUrl, PAReq, and TransactionID and include them in the Cardinal.continue function in order to proceed with the authentication session. NOTE: In the Cardinal.continue function, the 'Payload' field value should be populated with the data from PAReq." + } + ], + "maskable": true, + "parameters": [ + { + "name": "request", + "type": "SoftLayer_Billing_Payment_Card_ManualPayment", + "doc": "Details required to request a manual payment." + } + ], + "static": true + }, + "requestManualPaymentUsingCreditCardOnFile": { + "name": "requestManualPaymentUsingCreditCardOnFile", + "type": "SoftLayer_Billing_Payment_Card_ManualPayment", + "doc": "Retrieve the record data associated with the submission of a Manual Payment Request for a manual payment using a credit card which is on file and does not require an approval process. Softlayer customers are permitted to request a manual one-time payment at a minimum amount of $2.00. Customers may use an existing Credit Card on file (Mastercard, Visa, American Express). SoftLayer engages the credit card financial institution to submit the payment request. The financial institution's response and other data associated with the transaction are returned to the calling function. The applicable data generated during the request is returned to the calling function. ", + "docOverview": "Retrieve the record data associated with the submission of a Manual Payment Request which charges the manual payment to a credit card already on file. ", + "maskable": true, + "parameters": [ + { + "name": "amount", + "type": "string", + "doc": "dollar amount which will be charged to the specified credit card" + }, + { + "name": "payWithAlternateCardFlag", + "type": "boolean", + "doc": "if true, the charge will be applied to the alternate card on file", + "defaultValue": false + }, + { + "name": "note", + "type": "string", + "doc": "Optional note which will be added to the manual payment request", + "defaultValue": null + } + ], + "static": true + }, + "saveInternalCostRecovery": { + "name": "saveInternalCostRecovery", + "type": "void", + "parameters": [ + { + "name": "costRecoveryContainer", + "type": "SoftLayer_Container_Account_Internal_Ibm_CostRecovery" + } + ], + "static": true + }, + "setAbuseEmails": { + "name": "setAbuseEmails", + "type": "boolean", + "doc": "Set this account's abuse emails. Takes an array of email addresses as strings. ", + "docOverview": "Set this account's abuse emails.", + "parameters": [ + { + "name": "emails", + "type": "string", + "typeArray": true + } + ], + "static": true + }, + "setManagedPoolQuantity": { + "name": "setManagedPoolQuantity", + "type": "int", + "doc": "Set the total number of servers that are to be maintained in the given pool. When a server is ordered a new server will be put in the pool to replace the server that was removed to fill an order to maintain the desired pool availability quantity. ", + "docOverview": "Set the number of desired servers in the pool", + "parameters": [ + { + "name": "poolKeyName", + "type": "string", + "doc": "$poolKeyName" + }, + { + "name": "backendRouter", + "type": "string", + "doc": "$backendRouter" + }, + { + "name": "quantity", + "type": "int", + "doc": "$quantity" + } + ], + "static": true + }, + "setVlanSpan": { + "name": "setVlanSpan", + "type": "boolean", + "doc": "Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account. Enabling VLAN spanning allows an account's servers to talk on the same broadcast domain even if they reside within different private vlans. ", + "docOverview": "Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_User_Permission", + "description": "Throw the exception if the user does not have permission to modify VLAN spanning" + }, + { + "exception": "SoftLayer_Exception_NotReady", + "description": "Throw the exception if VLAN spanning cannot be enabled at this time" + } + ], + "parameters": [ + { + "name": "enabled", + "type": "boolean", + "doc": "Whether or not to enable private VLAN spanning on an account.", + "defaultValue": false + } + ], + "static": true + }, + "swapCreditCards": { + "name": "swapCreditCards", + "type": "boolean", + "static": true + }, + "syncCurrentUserPopulationWithPaas": { + "name": "syncCurrentUserPopulationWithPaas", + "type": "void", + "docOverview": "This method manually starts a synchronize operation for the current IBMid-authenticated user population of a linked account pair. \"Manually\" means \"independent of an account link operation\". ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws , 'Only Employees or Account master users may manually sync existing user populations.', if the active user is not an Employee or the master user of the account." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws , 'Account must be linked before user population can be synced.', if the account attempting to be synced is not linked." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws , 'There was an error syncing users in this account.', if an error is encountered during the execution of the user sync" + } + ], + "static": true + }, + "updateVpnUsersForResource": { + "name": "updateVpnUsersForResource", + "type": "boolean", + "doc": "[DEPRECATED] This method has been deprecated and will simply return false. ", + "docOverview": "[DEPRECATED] Creates or updates a user VPN access privileges for a server on account.", + "deprecated": true, + "parameters": [ + { + "name": "objectId", + "type": "int" + }, + { + "name": "objectType", + "type": "string" + } + ], + "static": true + }, + "validate": { + "name": "validate", + "type": "string", + "typeArray": true, + "doc": "This method will validate the following account fields. Included are the allowed characters for each field.Company Name (required): alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parenthesis, exclamation point. Maximum length: 100 characters. (Note: may not contain an email address)
First Name (required): alphabet, space, period, dash, comma, apostrophe. Maximum length: 30 characters.
Last Name (required): alphabet, space, period, dash, comma, apostrophe. Maximum length: 30 characters.
Email (required): Validates e-mail addresses against the syntax in RFC 822.
Address 1 (required): alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parentheses. Maximum length: 100 characters. (Note: may not contain an email address)
Address 2: alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parentheses. Maximum length: 100 characters. (Note: may not contain an email address)
City (required): alphabet, numbers, space, period, dash, apostrophe, forward slash, comma, parenthesis. Maximum length: 100 characters.
State (required if country is US, Brazil, Canada or India): Must be valid Alpha-2 ISO 3166-1 state code for that country.
Postal Code (required if country is US or Canada): Accepted characters are alphabet, numbers, dash, space. Maximum length: 50 characters.
Country (required): alphabet, numbers. Must be valid Alpha-2 ISO 3166-1 country code.
Office Phone (required): alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 100 characters.
Alternate Phone: alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 100 characters.
Fax Phone: alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 20 characters.
", + "docOverview": "Validates SoftLayer account information. Will return an error if any field is not valid.", + "static": true, + "parameters": [ + { + "name": "account", + "type": "SoftLayer_Account" + } + ] + }, + "validateManualPaymentAmount": { + "name": "validateManualPaymentAmount", + "type": "boolean", + "doc": "This method checks global and account specific requirements and returns true if the dollar amount entered is acceptable for this account and false otherwise. Please note the dollar amount is in USD. ", + "docOverview": "Ensure the amount requested for a manual payment is valid.", + "parameters": [ + { + "name": "amount", + "type": "string" + } + ], + "static": true + }, + "getAbuseEmail": { + "doc": "An email address that is responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to this address.", + "docOverview": "", + "name": "getAbuseEmail", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAbuseEmails": { + "doc": "Email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses.", + "docOverview": "", + "name": "getAbuseEmails", + "type": "SoftLayer_Account_AbuseEmail", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAccountContacts": { + "doc": "The account contacts on an account.", + "docOverview": "", + "name": "getAccountContacts", + "type": "SoftLayer_Account_Contact", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAccountLicenses": { + "doc": "The account software licenses owned by an account", + "docOverview": "", + "name": "getAccountLicenses", + "type": "SoftLayer_Software_AccountLicense", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAccountLinks": { + "doc": "", + "docOverview": "", + "name": "getAccountLinks", + "type": "SoftLayer_Account_Link", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAccountStatus": { + "doc": "An account's status presented in a more detailed data type.", + "docOverview": "", + "name": "getAccountStatus", + "type": "SoftLayer_Account_Status", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAccountDiscountBillingItem": { + "doc": "The billing item associated with an account's monthly discount.", + "docOverview": "", + "name": "getActiveAccountDiscountBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAccountLicenses": { + "doc": "The active account software licenses owned by an account", + "docOverview": "", + "name": "getActiveAccountLicenses", + "type": "SoftLayer_Software_AccountLicense", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveAddresses": { + "doc": "The active address(es) that belong to an account.", + "docOverview": "", + "name": "getActiveAddresses", + "type": "SoftLayer_Account_Address", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveAgreements": { + "doc": "All active agreements for an account", + "docOverview": "", + "name": "getActiveAgreements", + "type": "SoftLayer_Account_Agreement", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveBillingAgreements": { + "doc": "All billing agreements for an account", + "docOverview": "", + "name": "getActiveBillingAgreements", + "type": "SoftLayer_Account_Agreement", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCatalystEnrollment": { + "doc": "", + "docOverview": "", + "name": "getActiveCatalystEnrollment", + "type": "SoftLayer_Catalyst_Enrollment", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveColocationContainers": { + "doc": "Deprecated.", + "docOverview": "", + "name": "getActiveColocationContainers", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": true, + "limitable": true + }, + "getActiveFlexibleCreditEnrollment": { + "doc": "[Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments.", + "docOverview": "", + "name": "getActiveFlexibleCreditEnrollment", + "type": "SoftLayer_FlexibleCredit_Enrollment", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveFlexibleCreditEnrollments": { + "doc": "", + "docOverview": "", + "name": "getActiveFlexibleCreditEnrollments", + "type": "SoftLayer_FlexibleCredit_Enrollment", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveNotificationSubscribers": { + "doc": "", + "docOverview": "", + "name": "getActiveNotificationSubscribers", + "type": "SoftLayer_Notification_Subscriber", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveQuotes": { + "doc": "An account's non-expired quotes.", + "docOverview": "", + "name": "getActiveQuotes", + "type": "SoftLayer_Billing_Order_Quote", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveReservedCapacityAgreements": { + "doc": "Active reserved capacity agreements for an account", + "docOverview": "", + "name": "getActiveReservedCapacityAgreements", + "type": "SoftLayer_Account_Agreement", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveVirtualLicenses": { + "doc": "The virtual software licenses controlled by an account", + "docOverview": "", + "name": "getActiveVirtualLicenses", + "type": "SoftLayer_Software_VirtualLicense", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAdcLoadBalancers": { + "doc": "An account's associated load balancers.", + "docOverview": "", + "name": "getAdcLoadBalancers", + "type": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAddresses": { + "doc": "All the address(es) that belong to an account.", + "docOverview": "", + "name": "getAddresses", + "type": "SoftLayer_Account_Address", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAffiliateId": { + "doc": "An affiliate identifier associated with the customer account. ", + "docOverview": "", + "name": "getAffiliateId", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAllBillingItems": { + "doc": "The billing items that will be on an account's next invoice.", + "docOverview": "", + "name": "getAllBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAllCommissionBillingItems": { + "doc": "The billing items that will be on an account's next invoice.", + "docOverview": "", + "name": "getAllCommissionBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAllRecurringTopLevelBillingItems": { + "doc": "The billing items that will be on an account's next invoice.", + "docOverview": "", + "name": "getAllRecurringTopLevelBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAllRecurringTopLevelBillingItemsUnfiltered": { + "doc": "The billing items that will be on an account's next invoice. Does not consider associated items.", + "docOverview": "", + "name": "getAllRecurringTopLevelBillingItemsUnfiltered", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAllSubnetBillingItems": { + "doc": "The billing items that will be on an account's next invoice.", + "docOverview": "", + "name": "getAllSubnetBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAllTopLevelBillingItems": { + "doc": "All billing items of an account.", + "docOverview": "", + "name": "getAllTopLevelBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAllTopLevelBillingItemsUnfiltered": { + "doc": "The billing items that will be on an account's next invoice. Does not consider associated items.", + "docOverview": "", + "name": "getAllTopLevelBillingItemsUnfiltered", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAllowIbmIdSilentMigrationFlag": { + "doc": "Indicates whether this account is allowed to silently migrate to use IBMid Authentication.", + "docOverview": "", + "name": "getAllowIbmIdSilentMigrationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAllowsBluemixAccountLinkingFlag": { + "doc": "Flag indicating if this account can be linked with Bluemix.", + "docOverview": "", + "name": "getAllowsBluemixAccountLinkingFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getApplicationDeliveryControllers": { + "doc": "An account's associated application delivery controller records.", + "docOverview": "", + "name": "getApplicationDeliveryControllers", + "type": "SoftLayer_Network_Application_Delivery_Controller", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAttributes": { + "doc": "The account attribute values for a SoftLayer customer account.", + "docOverview": "", + "name": "getAttributes", + "type": "SoftLayer_Account_Attribute", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailablePublicNetworkVlans": { + "doc": "The public network VLANs assigned to an account.", + "docOverview": "", + "name": "getAvailablePublicNetworkVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBalance": { + "doc": "The account balance of a SoftLayer customer account. An account's balance is the amount of money owed to SoftLayer by the account holder, returned as a floating point number with two decimal places, measured in US Dollars ($USD). A negative account balance means the account holder has overpaid and is owed money by SoftLayer.", + "docOverview": "", + "name": "getBalance", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBandwidthAllotments": { + "doc": "The bandwidth allotments for an account.", + "docOverview": "", + "name": "getBandwidthAllotments", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllotmentsOverAllocation": { + "doc": "The bandwidth allotments for an account currently over allocation.", + "docOverview": "", + "name": "getBandwidthAllotmentsOverAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllotmentsProjectedOverAllocation": { + "doc": "The bandwidth allotments for an account projected to go over allocation.", + "docOverview": "", + "name": "getBandwidthAllotmentsProjectedOverAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBareMetalInstances": { + "doc": "An account's associated bare metal server objects.", + "docOverview": "", + "name": "getBareMetalInstances", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBillingAgreements": { + "doc": "All billing agreements for an account", + "docOverview": "", + "name": "getBillingAgreements", + "type": "SoftLayer_Account_Agreement", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBillingInfo": { + "doc": "An account's billing information.", + "docOverview": "", + "name": "getBillingInfo", + "type": "SoftLayer_Billing_Info", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBlockDeviceTemplateGroups": { + "doc": "Private template group objects (parent and children) and the shared template group objects (parent only) for an account.", + "docOverview": "", + "name": "getBlockDeviceTemplateGroups", + "type": "SoftLayer_Virtual_Guest_Block_Device_Template_Group", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBlockSelfServiceBrandMigration": { + "doc": "Flag indicating whether this account is restricted from performing a self-service brand migration by updating their credit card details.", + "docOverview": "", + "name": "getBlockSelfServiceBrandMigration", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBluemixAccountId": { + "doc": "", + "docOverview": "", + "name": "getBluemixAccountId", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBluemixAccountLink": { + "doc": "The Platform account link associated with this SoftLayer account, if one exists.", + "docOverview": "", + "name": "getBluemixAccountLink", + "type": "SoftLayer_Account_Link_Bluemix", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBluemixLinkedFlag": { + "doc": "Returns true if this account is linked to IBM Bluemix, false if not.", + "docOverview": "", + "name": "getBluemixLinkedFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBrand": { + "doc": "", + "docOverview": "", + "name": "getBrand", + "type": "SoftLayer_Brand", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBrandAccountFlag": { + "doc": "", + "docOverview": "", + "name": "getBrandAccountFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBrandKeyName": { + "doc": "The brand keyName.", + "docOverview": "", + "name": "getBrandKeyName", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBusinessPartner": { + "doc": "The Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level.", + "docOverview": "", + "name": "getBusinessPartner", + "type": "SoftLayer_Account_Business_Partner", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCanOrderAdditionalVlansFlag": { + "doc": "[DEPRECATED] All accounts may order VLANs.", + "docOverview": "", + "name": "getCanOrderAdditionalVlansFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": true + }, + "getCarts": { + "doc": "An account's active carts.", + "docOverview": "", + "name": "getCarts", + "type": "SoftLayer_Billing_Order_Quote", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCatalystEnrollments": { + "doc": "", + "docOverview": "", + "name": "getCatalystEnrollments", + "type": "SoftLayer_Catalyst_Enrollment", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getClosedTickets": { + "doc": "All closed tickets associated with an account.", + "docOverview": "", + "name": "getClosedTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDatacentersWithSubnetAllocations": { + "doc": "Datacenters which contain subnets that the account has access to route.", + "docOverview": "", + "name": "getDatacentersWithSubnetAllocations", + "type": "SoftLayer_Location", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDedicatedHosts": { + "doc": "An account's associated virtual dedicated host objects.", + "docOverview": "", + "name": "getDedicatedHosts", + "type": "SoftLayer_Virtual_DedicatedHost", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDisablePaymentProcessingFlag": { + "doc": "A flag indicating whether payments are processed for this account.", + "docOverview": "", + "name": "getDisablePaymentProcessingFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getDisplaySupportRepresentativeAssignments": { + "doc": "The SoftLayer employees that an account is assigned to.", + "docOverview": "", + "name": "getDisplaySupportRepresentativeAssignments", + "type": "SoftLayer_Account_Attachment_Employee", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDomains": { + "doc": "The DNS domains associated with an account.", + "docOverview": "", + "name": "getDomains", + "type": "SoftLayer_Dns_Domain", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDomainsWithoutSecondaryDnsRecords": { + "doc": "The DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer.", + "docOverview": "", + "name": "getDomainsWithoutSecondaryDnsRecords", + "type": "SoftLayer_Dns_Domain", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getEuSupportedFlag": { + "doc": "Boolean flag dictating whether or not this account has the EU Supported flag. This flag indicates that this account uses IBM Cloud services to process EU citizen's personal data.", + "docOverview": "", + "name": "getEuSupportedFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getEvaultCapacityGB": { + "doc": "The total capacity of Legacy EVault Volumes on an account, in GB.", + "docOverview": "", + "name": "getEvaultCapacityGB", + "type": "unsignedInt", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getEvaultMasterUsers": { + "doc": "An account's master EVault user. This is only used when an account has EVault service.", + "docOverview": "", + "name": "getEvaultMasterUsers", + "type": "SoftLayer_Account_Password", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getEvaultNetworkStorage": { + "doc": "An account's associated EVault storage volumes.", + "docOverview": "", + "name": "getEvaultNetworkStorage", + "type": "SoftLayer_Network_Storage", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getExpiredSecurityCertificates": { + "doc": "Stored security certificates that are expired (ie. SSL)", + "docOverview": "", + "name": "getExpiredSecurityCertificates", + "type": "SoftLayer_Security_Certificate", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFacilityLogs": { + "doc": "Logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter.", + "docOverview": "", + "name": "getFacilityLogs", + "type": "SoftLayer_User_Access_Facility_Log", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFileBlockBetaAccessFlag": { + "doc": "", + "docOverview": "", + "name": "getFileBlockBetaAccessFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getFlexibleCreditEnrollments": { + "doc": "All of the account's current and former Flexible Credit enrollments.", + "docOverview": "", + "name": "getFlexibleCreditEnrollments", + "type": "SoftLayer_FlexibleCredit_Enrollment", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getForcePaasAccountLinkDate": { + "doc": "Timestamp representing the point in time when an account is required to link with PaaS.", + "docOverview": "", + "name": "getForcePaasAccountLinkDate", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getGlobalIpRecords": { + "doc": "", + "docOverview": "", + "name": "getGlobalIpRecords", + "type": "SoftLayer_Network_Subnet_IpAddress_Global", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getGlobalIpv4Records": { + "doc": "", + "docOverview": "", + "name": "getGlobalIpv4Records", + "type": "SoftLayer_Network_Subnet_IpAddress_Global", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getGlobalIpv6Records": { + "doc": "", + "docOverview": "", + "name": "getGlobalIpv6Records", + "type": "SoftLayer_Network_Subnet_IpAddress_Global", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardware": { + "doc": "An account's associated hardware objects.", + "docOverview": "", + "name": "getHardware", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareOverBandwidthAllocation": { + "doc": "An account's associated hardware objects currently over bandwidth allocation.", + "docOverview": "", + "name": "getHardwareOverBandwidthAllocation", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareProjectedOverBandwidthAllocation": { + "doc": "An account's associated hardware objects projected to go over bandwidth allocation.", + "docOverview": "", + "name": "getHardwareProjectedOverBandwidthAllocation", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareWithCpanel": { + "doc": "All hardware associated with an account that has the cPanel web hosting control panel installed.", + "docOverview": "", + "name": "getHardwareWithCpanel", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareWithHelm": { + "doc": "All hardware associated with an account that has the Helm web hosting control panel installed.", + "docOverview": "", + "name": "getHardwareWithHelm", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareWithMcafee": { + "doc": "All hardware associated with an account that has McAfee Secure software components.", + "docOverview": "", + "name": "getHardwareWithMcafee", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareWithMcafeeAntivirusRedhat": { + "doc": "All hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components.", + "docOverview": "", + "name": "getHardwareWithMcafeeAntivirusRedhat", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareWithMcafeeAntivirusWindows": { + "doc": "All hardware associated with an account that has McAfee Secure AntiVirus for Windows software components.", + "docOverview": "", + "name": "getHardwareWithMcafeeAntivirusWindows", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareWithMcafeeIntrusionDetectionSystem": { + "doc": "All hardware associated with an account that has McAfee Secure Intrusion Detection System software components.", + "docOverview": "", + "name": "getHardwareWithMcafeeIntrusionDetectionSystem", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareWithPlesk": { + "doc": "All hardware associated with an account that has the Plesk web hosting control panel installed.", + "docOverview": "", + "name": "getHardwareWithPlesk", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareWithQuantastor": { + "doc": "All hardware associated with an account that has the QuantaStor storage system installed.", + "docOverview": "", + "name": "getHardwareWithQuantastor", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareWithUrchin": { + "doc": "All hardware associated with an account that has the Urchin web traffic analytics package installed.", + "docOverview": "", + "name": "getHardwareWithUrchin", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHardwareWithWindows": { + "doc": "All hardware associated with an account that is running a version of the Microsoft Windows operating system.", + "docOverview": "", + "name": "getHardwareWithWindows", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHasEvaultBareMetalRestorePluginFlag": { + "doc": "Return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0.", + "docOverview": "", + "name": "getHasEvaultBareMetalRestorePluginFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getHasIderaBareMetalRestorePluginFlag": { + "doc": "Return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0.", + "docOverview": "", + "name": "getHasIderaBareMetalRestorePluginFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getHasPendingOrder": { + "doc": "The number of orders in a PENDING status for a SoftLayer customer account.", + "docOverview": "", + "name": "getHasPendingOrder", + "type": "unsignedInt", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getHasR1softBareMetalRestorePluginFlag": { + "doc": "Return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0.", + "docOverview": "", + "name": "getHasR1softBareMetalRestorePluginFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getHourlyBareMetalInstances": { + "doc": "An account's associated hourly bare metal server objects.", + "docOverview": "", + "name": "getHourlyBareMetalInstances", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyServiceBillingItems": { + "doc": "Hourly service billing items that will be on an account's next invoice.", + "docOverview": "", + "name": "getHourlyServiceBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyVirtualGuests": { + "doc": "An account's associated hourly virtual guest objects.", + "docOverview": "", + "name": "getHourlyVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHubNetworkStorage": { + "doc": "An account's associated Virtual Storage volumes.", + "docOverview": "", + "name": "getHubNetworkStorage", + "type": "SoftLayer_Network_Storage", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getIbmCustomerNumber": { + "doc": "Unique identifier for a customer used throughout IBM.", + "docOverview": "", + "name": "getIbmCustomerNumber", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getIbmIdAuthenticationRequiredFlag": { + "doc": "Indicates whether this account requires IBMid authentication.", + "docOverview": "", + "name": "getIbmIdAuthenticationRequiredFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getIbmIdMigrationExpirationTimestamp": { + "doc": "This key is deprecated and should not be used.", + "docOverview": "", + "name": "getIbmIdMigrationExpirationTimestamp", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInProgressExternalAccountSetup": { + "doc": "An in progress request to switch billing systems.", + "docOverview": "", + "name": "getInProgressExternalAccountSetup", + "type": "SoftLayer_Account_External_Setup", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInternalCciHostAccountFlag": { + "doc": "Account attribute flag indicating internal cci host account.", + "docOverview": "", + "name": "getInternalCciHostAccountFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInternalImageTemplateCreationFlag": { + "doc": "Account attribute flag indicating account creates internal image templates.", + "docOverview": "", + "name": "getInternalImageTemplateCreationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInternalNotes": { + "doc": "", + "docOverview": "", + "name": "getInternalNotes", + "type": "SoftLayer_Account_Note", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getInternalRestrictionFlag": { + "doc": "Account attribute flag indicating restricted account.", + "docOverview": "", + "name": "getInternalRestrictionFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoices": { + "doc": "An account's associated billing invoices.", + "docOverview": "", + "name": "getInvoices", + "type": "SoftLayer_Billing_Invoice", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getIpAddresses": { + "doc": "", + "docOverview": "", + "name": "getIpAddresses", + "type": "SoftLayer_Network_Subnet_IpAddress", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getIscsiIsolationDisabled": { + "doc": "", + "docOverview": "", + "name": "getIscsiIsolationDisabled", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getIscsiNetworkStorage": { + "doc": "An account's associated iSCSI storage volumes.", + "docOverview": "", + "name": "getIscsiNetworkStorage", + "type": "SoftLayer_Network_Storage", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getLastCanceledBillingItem": { + "doc": "The most recently canceled billing item.", + "docOverview": "", + "name": "getLastCanceledBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLastCancelledServerBillingItem": { + "doc": "The most recent cancelled server billing item.", + "docOverview": "", + "name": "getLastCancelledServerBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLastFiveClosedAbuseTickets": { + "doc": "The five most recently closed abuse tickets associated with an account.", + "docOverview": "", + "name": "getLastFiveClosedAbuseTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getLastFiveClosedAccountingTickets": { + "doc": "The five most recently closed accounting tickets associated with an account.", + "docOverview": "", + "name": "getLastFiveClosedAccountingTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getLastFiveClosedOtherTickets": { + "doc": "The five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.", + "docOverview": "", + "name": "getLastFiveClosedOtherTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getLastFiveClosedSalesTickets": { + "doc": "The five most recently closed sales tickets associated with an account.", + "docOverview": "", + "name": "getLastFiveClosedSalesTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getLastFiveClosedSupportTickets": { + "doc": "The five most recently closed support tickets associated with an account.", + "docOverview": "", + "name": "getLastFiveClosedSupportTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getLastFiveClosedTickets": { + "doc": "The five most recently closed tickets associated with an account.", + "docOverview": "", + "name": "getLastFiveClosedTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getLatestBillDate": { + "doc": "An account's most recent billing date.", + "docOverview": "", + "name": "getLatestBillDate", + "type": "dateTime", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLatestRecurringInvoice": { + "doc": "An account's latest recurring invoice.", + "docOverview": "", + "name": "getLatestRecurringInvoice", + "type": "SoftLayer_Billing_Invoice", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLatestRecurringPendingInvoice": { + "doc": "An account's latest recurring pending invoice.", + "docOverview": "", + "name": "getLatestRecurringPendingInvoice", + "type": "SoftLayer_Billing_Invoice", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLegacyIscsiCapacityGB": { + "doc": "The total capacity of Legacy iSCSI Volumes on an account, in GB.", + "docOverview": "", + "name": "getLegacyIscsiCapacityGB", + "type": "unsignedInt", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLoadBalancers": { + "doc": "An account's associated load balancers.", + "docOverview": "", + "name": "getLoadBalancers", + "type": "SoftLayer_Network_LoadBalancer_VirtualIpAddress", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getLockboxCapacityGB": { + "doc": "The total capacity of Legacy lockbox Volumes on an account, in GB.", + "docOverview": "", + "name": "getLockboxCapacityGB", + "type": "unsignedInt", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLockboxNetworkStorage": { + "doc": "An account's associated Lockbox storage volumes.", + "docOverview": "", + "name": "getLockboxNetworkStorage", + "type": "SoftLayer_Network_Storage", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getManualPaymentsUnderReview": { + "doc": "", + "docOverview": "", + "name": "getManualPaymentsUnderReview", + "type": "SoftLayer_Billing_Payment_Card_ManualPayment", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getMasterUser": { + "doc": "An account's master user.", + "docOverview": "", + "name": "getMasterUser", + "type": "SoftLayer_User_Customer", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getMediaDataTransferRequests": { + "doc": "An account's media transfer service requests.", + "docOverview": "", + "name": "getMediaDataTransferRequests", + "type": "SoftLayer_Account_Media_Data_Transfer_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getMigratedToIbmCloudPortalFlag": { + "doc": "Flag indicating whether this account is restricted to the IBM Cloud portal.", + "docOverview": "", + "name": "getMigratedToIbmCloudPortalFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getMonthlyBareMetalInstances": { + "doc": "An account's associated monthly bare metal server objects.", + "docOverview": "", + "name": "getMonthlyBareMetalInstances", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getMonthlyVirtualGuests": { + "doc": "An account's associated monthly virtual guest objects.", + "docOverview": "", + "name": "getMonthlyVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNasNetworkStorage": { + "doc": "An account's associated NAS storage volumes.", + "docOverview": "", + "name": "getNasNetworkStorage", + "type": "SoftLayer_Network_Storage", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkCreationFlag": { + "doc": "[Deprecated] Whether or not this account can define their own networks.", + "docOverview": "", + "name": "getNetworkCreationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNetworkGateways": { + "doc": "All network gateway devices on this account.", + "docOverview": "", + "name": "getNetworkGateways", + "type": "SoftLayer_Network_Gateway", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkHardware": { + "doc": "An account's associated network hardware.", + "docOverview": "", + "name": "getNetworkHardware", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkMessageDeliveryAccounts": { + "doc": "", + "docOverview": "", + "name": "getNetworkMessageDeliveryAccounts", + "type": "SoftLayer_Network_Message_Delivery", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkMonitorDownHardware": { + "doc": "Hardware which is currently experiencing a service failure.", + "docOverview": "", + "name": "getNetworkMonitorDownHardware", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkMonitorDownVirtualGuests": { + "doc": "Virtual guest which is currently experiencing a service failure.", + "docOverview": "", + "name": "getNetworkMonitorDownVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkMonitorRecoveringHardware": { + "doc": "Hardware which is currently recovering from a service failure.", + "docOverview": "", + "name": "getNetworkMonitorRecoveringHardware", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkMonitorRecoveringVirtualGuests": { + "doc": "Virtual guest which is currently recovering from a service failure.", + "docOverview": "", + "name": "getNetworkMonitorRecoveringVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkMonitorUpHardware": { + "doc": "Hardware which is currently online.", + "docOverview": "", + "name": "getNetworkMonitorUpHardware", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkMonitorUpVirtualGuests": { + "doc": "Virtual guest which is currently online.", + "docOverview": "", + "name": "getNetworkMonitorUpVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkStorage": { + "doc": "An account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.", + "docOverview": "", + "name": "getNetworkStorage", + "type": "SoftLayer_Network_Storage", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkStorageGroups": { + "doc": "An account's Network Storage groups.", + "docOverview": "", + "name": "getNetworkStorageGroups", + "type": "SoftLayer_Network_Storage_Group", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkTunnelContexts": { + "doc": "IPSec network tunnels for an account.", + "docOverview": "", + "name": "getNetworkTunnelContexts", + "type": "SoftLayer_Network_Tunnel_Module_Context", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNetworkVlanSpan": { + "doc": "Whether or not an account has automatic private VLAN spanning enabled.", + "docOverview": "", + "name": "getNetworkVlanSpan", + "type": "SoftLayer_Account_Network_Vlan_Span", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNetworkVlans": { + "doc": "All network VLANs assigned to an account.", + "docOverview": "", + "name": "getNetworkVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceIncubatorExemptTotal": { + "doc": "The pre-tax total amount exempt from incubator credit for the account's next invoice. This field is now deprecated and will soon be removed. Please update all references to instead use nextInvoiceTotalAmount", + "docOverview": "", + "name": "getNextInvoiceIncubatorExemptTotal", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoicePlatformServicesTotalAmount": { + "doc": "The pre-tax platform services total amount of an account's next invoice.", + "docOverview": "", + "name": "getNextInvoicePlatformServicesTotalAmount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceRecurringAmountEligibleForAccountDiscount": { + "doc": "The total recurring charge amount of an account's next invoice eligible for account discount measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "docOverview": "", + "name": "getNextInvoiceRecurringAmountEligibleForAccountDiscount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTopLevelBillingItems": { + "doc": "The billing items that will be on an account's next invoice.", + "docOverview": "", + "name": "getNextInvoiceTopLevelBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalAmount": { + "doc": "The pre-tax total amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "docOverview": "", + "name": "getNextInvoiceTotalAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "The total one-time charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "The total one-time tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmountBeforeAccountDiscount": { + "doc": "The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmountBeforeAccountDiscount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "The total recurring tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalTaxableRecurringAmount": { + "doc": "The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.", + "docOverview": "", + "name": "getNextInvoiceTotalTaxableRecurringAmount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNotificationSubscribers": { + "doc": "", + "docOverview": "", + "name": "getNotificationSubscribers", + "type": "SoftLayer_Notification_Subscriber", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenAbuseTickets": { + "doc": "The open abuse tickets associated with an account.", + "docOverview": "", + "name": "getOpenAbuseTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenAccountingTickets": { + "doc": "The open accounting tickets associated with an account.", + "docOverview": "", + "name": "getOpenAccountingTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenBillingTickets": { + "doc": "The open billing tickets associated with an account.", + "docOverview": "", + "name": "getOpenBillingTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenCancellationRequests": { + "doc": "An open ticket requesting cancellation of this server, if one exists.", + "docOverview": "", + "name": "getOpenCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenOtherTickets": { + "doc": "The open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.", + "docOverview": "", + "name": "getOpenOtherTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenRecurringInvoices": { + "doc": "An account's recurring invoices.", + "docOverview": "", + "name": "getOpenRecurringInvoices", + "type": "SoftLayer_Billing_Invoice", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenSalesTickets": { + "doc": "The open sales tickets associated with an account.", + "docOverview": "", + "name": "getOpenSalesTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenStackAccountLinks": { + "doc": "", + "docOverview": "", + "name": "getOpenStackAccountLinks", + "type": "SoftLayer_Account_Link", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenStackObjectStorage": { + "doc": "An account's associated Openstack related Object Storage accounts.", + "docOverview": "", + "name": "getOpenStackObjectStorage", + "type": "SoftLayer_Network_Storage", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenSupportTickets": { + "doc": "The open support tickets associated with an account.", + "docOverview": "", + "name": "getOpenSupportTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenTickets": { + "doc": "All open tickets associated with an account.", + "docOverview": "", + "name": "getOpenTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOpenTicketsWaitingOnCustomer": { + "doc": "All open tickets associated with an account last edited by an employee.", + "docOverview": "", + "name": "getOpenTicketsWaitingOnCustomer", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrders": { + "doc": "An account's associated billing orders excluding upgrades.", + "docOverview": "", + "name": "getOrders", + "type": "SoftLayer_Billing_Order", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrphanBillingItems": { + "doc": "The billing items that have no parent billing item. These are items that don't necessarily belong to a single server.", + "docOverview": "", + "name": "getOrphanBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOwnedBrands": { + "doc": "", + "docOverview": "", + "name": "getOwnedBrands", + "type": "SoftLayer_Brand", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOwnedHardwareGenericComponentModels": { + "doc": "", + "docOverview": "", + "name": "getOwnedHardwareGenericComponentModels", + "type": "SoftLayer_Hardware_Component_Model_Generic", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPaymentProcessors": { + "doc": "", + "docOverview": "", + "name": "getPaymentProcessors", + "type": "SoftLayer_Billing_Payment_Processor", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPendingEvents": { + "doc": "", + "docOverview": "", + "name": "getPendingEvents", + "type": "SoftLayer_Notification_Occurrence_Event", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPendingInvoice": { + "doc": "An account's latest open (pending) invoice.", + "docOverview": "", + "name": "getPendingInvoice", + "type": "SoftLayer_Billing_Invoice", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingInvoiceTopLevelItems": { + "doc": "A list of top-level invoice items that are on an account's currently pending invoice.", + "docOverview": "", + "name": "getPendingInvoiceTopLevelItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPendingInvoiceTotalAmount": { + "doc": "The total amount of an account's pending invoice, if one exists.", + "docOverview": "", + "name": "getPendingInvoiceTotalAmount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingInvoiceTotalOneTimeAmount": { + "doc": "The total one-time charges for an account's pending invoice, if one exists. In other words, it is the sum of one-time charges, setup fees, and labor fees. It does not include taxes.", + "docOverview": "", + "name": "getPendingInvoiceTotalOneTimeAmount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingInvoiceTotalOneTimeTaxAmount": { + "doc": "The sum of all the taxes related to one time charges for an account's pending invoice, if one exists.", + "docOverview": "", + "name": "getPendingInvoiceTotalOneTimeTaxAmount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingInvoiceTotalRecurringAmount": { + "doc": "The total recurring amount of an account's pending invoice, if one exists.", + "docOverview": "", + "name": "getPendingInvoiceTotalRecurringAmount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingInvoiceTotalRecurringTaxAmount": { + "doc": "The total amount of the recurring taxes on an account's pending invoice, if one exists.", + "docOverview": "", + "name": "getPendingInvoiceTotalRecurringTaxAmount", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPermissionGroups": { + "doc": "An account's permission groups.", + "docOverview": "", + "name": "getPermissionGroups", + "type": "SoftLayer_User_Permission_Group", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPermissionRoles": { + "doc": "An account's user roles.", + "docOverview": "", + "name": "getPermissionRoles", + "type": "SoftLayer_User_Permission_Role", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPlacementGroups": { + "doc": "An account's associated virtual placement groups.", + "docOverview": "", + "name": "getPlacementGroups", + "type": "SoftLayer_Virtual_PlacementGroup", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPortableStorageVolumes": { + "doc": "", + "docOverview": "", + "name": "getPortableStorageVolumes", + "type": "SoftLayer_Virtual_Disk_Image", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPostProvisioningHooks": { + "doc": "Customer specified URIs that are downloaded onto a newly provisioned or reloaded server. If the URI is sent over https it will be executed directly on the server.", + "docOverview": "", + "name": "getPostProvisioningHooks", + "type": "SoftLayer_Provisioning_Hook", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPptpVpnAllowedFlag": { + "doc": "(Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access.", + "docOverview": "", + "name": "getPptpVpnAllowedFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPptpVpnUsers": { + "doc": "An account's associated portal users with PPTP VPN access. (Deprecated)", + "docOverview": "", + "name": "getPptpVpnUsers", + "type": "SoftLayer_User_Customer", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPreOpenRecurringInvoices": { + "doc": "An account's invoices in the PRE_OPEN status.", + "docOverview": "", + "name": "getPreOpenRecurringInvoices", + "type": "SoftLayer_Billing_Invoice", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPreviousRecurringRevenue": { + "doc": "The total recurring amount for an accounts previous revenue.", + "docOverview": "", + "name": "getPreviousRecurringRevenue", + "type": "decimal", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPriceRestrictions": { + "doc": "The item price that an account is restricted to.", + "docOverview": "", + "name": "getPriceRestrictions", + "type": "SoftLayer_Product_Item_Price_Account_Restriction", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPriorityOneTickets": { + "doc": "All priority one tickets associated with an account.", + "docOverview": "", + "name": "getPriorityOneTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPrivateBlockDeviceTemplateGroups": { + "doc": "Private and shared template group objects (parent only) for an account.", + "docOverview": "", + "name": "getPrivateBlockDeviceTemplateGroups", + "type": "SoftLayer_Virtual_Guest_Block_Device_Template_Group", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPrivateIpAddresses": { + "doc": "", + "docOverview": "", + "name": "getPrivateIpAddresses", + "type": "SoftLayer_Network_Subnet_IpAddress", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPrivateNetworkVlans": { + "doc": "The private network VLANs assigned to an account.", + "docOverview": "", + "name": "getPrivateNetworkVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPrivateSubnets": { + "doc": "All private subnets associated with an account.", + "docOverview": "", + "name": "getPrivateSubnets", + "type": "SoftLayer_Network_Subnet", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getProofOfConceptAccountFlag": { + "doc": "Boolean flag indicating whether or not this account is a Proof of Concept account.", + "docOverview": "", + "name": "getProofOfConceptAccountFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPublicIpAddresses": { + "doc": "", + "docOverview": "", + "name": "getPublicIpAddresses", + "type": "SoftLayer_Network_Subnet_IpAddress", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPublicNetworkVlans": { + "doc": "The public network VLANs assigned to an account.", + "docOverview": "", + "name": "getPublicNetworkVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getPublicSubnets": { + "doc": "All public network subnets associated with an account.", + "docOverview": "", + "name": "getPublicSubnets", + "type": "SoftLayer_Network_Subnet", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getQuotes": { + "doc": "An account's quotes.", + "docOverview": "", + "name": "getQuotes", + "type": "SoftLayer_Billing_Order_Quote", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getRecentEvents": { + "doc": "", + "docOverview": "", + "name": "getRecentEvents", + "type": "SoftLayer_Notification_Occurrence_Event", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getReferralPartner": { + "doc": "The Referral Partner for this account, if any.", + "docOverview": "", + "name": "getReferralPartner", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getReferredAccountFlag": { + "doc": "Flag indicating if the account was referred.", + "docOverview": "", + "name": "getReferredAccountFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getReferredAccounts": { + "doc": "If this is a account is a referral partner, the accounts this referral partner has referred", + "docOverview": "", + "name": "getReferredAccounts", + "type": "SoftLayer_Account", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getRegulatedWorkloads": { + "doc": "", + "docOverview": "", + "name": "getRegulatedWorkloads", + "type": "SoftLayer_Legal_RegulatedWorkload", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getRemoteManagementCommandRequests": { + "doc": "Remote management command requests for an account", + "docOverview": "", + "name": "getRemoteManagementCommandRequests", + "type": "SoftLayer_Hardware_Component_RemoteManagement_Command_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getReplicationEvents": { + "doc": "The Replication events for all Network Storage volumes on an account.", + "docOverview": "", + "name": "getReplicationEvents", + "type": "SoftLayer_Network_Storage_Event", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getRequireSilentIBMidUserCreation": { + "doc": "Indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not.", + "docOverview": "", + "name": "getRequireSilentIBMidUserCreation", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getReservedCapacityAgreements": { + "doc": "All reserved capacity agreements for an account", + "docOverview": "", + "name": "getReservedCapacityAgreements", + "type": "SoftLayer_Account_Agreement", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getReservedCapacityGroups": { + "doc": "The reserved capacity groups owned by this account.", + "docOverview": "", + "name": "getReservedCapacityGroups", + "type": "SoftLayer_Virtual_ReservedCapacityGroup", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getRouters": { + "doc": "All Routers that an accounts VLANs reside on", + "docOverview": "", + "name": "getRouters", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getRwhoisData": { + "doc": "DEPRECATED", + "docOverview": "", + "name": "getRwhoisData", + "type": "SoftLayer_Network_Subnet_Rwhois_Data", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": true, + "limitable": true + }, + "getSamlAuthentication": { + "doc": "The SAML configuration for this account.", + "docOverview": "", + "name": "getSamlAuthentication", + "type": "SoftLayer_Account_Authentication_Saml", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSecondaryDomains": { + "doc": "The secondary DNS records for a SoftLayer customer account.", + "docOverview": "", + "name": "getSecondaryDomains", + "type": "SoftLayer_Dns_Secondary", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getSecurityCertificates": { + "doc": "Stored security certificates (ie. SSL)", + "docOverview": "", + "name": "getSecurityCertificates", + "type": "SoftLayer_Security_Certificate", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getSecurityGroups": { + "doc": "The security groups belonging to this account.", + "docOverview": "", + "name": "getSecurityGroups", + "type": "SoftLayer_Network_SecurityGroup", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getSecurityLevel": { + "doc": "", + "docOverview": "", + "name": "getSecurityLevel", + "type": "SoftLayer_Security_Level", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSecurityScanRequests": { + "doc": "An account's vulnerability scan requests.", + "docOverview": "", + "name": "getSecurityScanRequests", + "type": "SoftLayer_Network_Security_Scanner_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getServiceBillingItems": { + "doc": "The service billing items that will be on an account's next invoice. ", + "docOverview": "", + "name": "getServiceBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getShipments": { + "doc": "Shipments that belong to the customer's account.", + "docOverview": "", + "name": "getShipments", + "type": "SoftLayer_Account_Shipment", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getSshKeys": { + "doc": "Customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server.", + "docOverview": "", + "name": "getSshKeys", + "type": "SoftLayer_Security_Ssh_Key", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getSslVpnUsers": { + "doc": "An account's associated portal users with SSL VPN access.", + "docOverview": "", + "name": "getSslVpnUsers", + "type": "SoftLayer_User_Customer", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getStandardPoolVirtualGuests": { + "doc": "An account's virtual guest objects that are hosted on a user provisioned hypervisor.", + "docOverview": "", + "name": "getStandardPoolVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getSubnetRegistrationDetails": { + "doc": "", + "docOverview": "", + "name": "getSubnetRegistrationDetails", + "type": "SoftLayer_Account_Regional_Registry_Detail", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": true, + "limitable": true + }, + "getSubnetRegistrations": { + "doc": "", + "docOverview": "", + "name": "getSubnetRegistrations", + "type": "SoftLayer_Network_Subnet_Registration", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": true, + "limitable": true + }, + "getSubnets": { + "doc": "All network subnets associated with an account.", + "docOverview": "", + "name": "getSubnets", + "type": "SoftLayer_Network_Subnet", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getSupportRepresentatives": { + "doc": "The SoftLayer employees that an account is assigned to.", + "docOverview": "", + "name": "getSupportRepresentatives", + "type": "SoftLayer_User_Employee", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getSupportSubscriptions": { + "doc": "The active support subscriptions for this account.", + "docOverview": "", + "name": "getSupportSubscriptions", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getSupportTier": { + "doc": "", + "docOverview": "", + "name": "getSupportTier", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSuppressInvoicesFlag": { + "doc": "A flag indicating to suppress invoices.", + "docOverview": "", + "name": "getSuppressInvoicesFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getTags": { + "doc": "", + "docOverview": "", + "name": "getTags", + "type": "SoftLayer_Tag", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getTestAccountAttributeFlag": { + "doc": "Account attribute flag indicating test account.", + "docOverview": "", + "name": "getTestAccountAttributeFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getTickets": { + "doc": "An account's associated tickets.", + "docOverview": "", + "name": "getTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getTicketsClosedInTheLastThreeDays": { + "doc": "Tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account.", + "docOverview": "", + "name": "getTicketsClosedInTheLastThreeDays", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getTicketsClosedToday": { + "doc": "Tickets closed today associated with an account.", + "docOverview": "", + "name": "getTicketsClosedToday", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getUpgradeRequests": { + "doc": "An account's associated upgrade requests.", + "docOverview": "", + "name": "getUpgradeRequests", + "type": "SoftLayer_Product_Upgrade_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getUsers": { + "doc": "An account's portal users.", + "docOverview": "", + "name": "getUsers", + "type": "SoftLayer_User_Customer", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getValidSecurityCertificates": { + "doc": "Stored security certificates that are not expired (ie. SSL)", + "docOverview": "", + "name": "getValidSecurityCertificates", + "type": "SoftLayer_Security_Certificate", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualDedicatedRacks": { + "doc": "The bandwidth pooling for this account.", + "docOverview": "", + "name": "getVirtualDedicatedRacks", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualDiskImages": { + "doc": "An account's associated virtual server virtual disk images.", + "docOverview": "", + "name": "getVirtualDiskImages", + "type": "SoftLayer_Virtual_Disk_Image", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuests": { + "doc": "An account's associated virtual guest objects.", + "docOverview": "", + "name": "getVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuestsOverBandwidthAllocation": { + "doc": "An account's associated virtual guest objects currently over bandwidth allocation.", + "docOverview": "", + "name": "getVirtualGuestsOverBandwidthAllocation", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuestsProjectedOverBandwidthAllocation": { + "doc": "An account's associated virtual guest objects currently over bandwidth allocation.", + "docOverview": "", + "name": "getVirtualGuestsProjectedOverBandwidthAllocation", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuestsWithCpanel": { + "doc": "All virtual guests associated with an account that has the cPanel web hosting control panel installed.", + "docOverview": "", + "name": "getVirtualGuestsWithCpanel", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuestsWithMcafee": { + "doc": "All virtual guests associated with an account that have McAfee Secure software components.", + "docOverview": "", + "name": "getVirtualGuestsWithMcafee", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuestsWithMcafeeAntivirusRedhat": { + "doc": "All virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components.", + "docOverview": "", + "name": "getVirtualGuestsWithMcafeeAntivirusRedhat", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuestsWithMcafeeAntivirusWindows": { + "doc": "All virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components.", + "docOverview": "", + "name": "getVirtualGuestsWithMcafeeAntivirusWindows", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuestsWithMcafeeIntrusionDetectionSystem": { + "doc": "All virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components.", + "docOverview": "", + "name": "getVirtualGuestsWithMcafeeIntrusionDetectionSystem", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuestsWithPlesk": { + "doc": "All virtual guests associated with an account that has the Plesk web hosting control panel installed.", + "docOverview": "", + "name": "getVirtualGuestsWithPlesk", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuestsWithQuantastor": { + "doc": "All virtual guests associated with an account that have the QuantaStor storage system installed.", + "docOverview": "", + "name": "getVirtualGuestsWithQuantastor", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuestsWithUrchin": { + "doc": "All virtual guests associated with an account that has the Urchin web traffic analytics package installed.", + "docOverview": "", + "name": "getVirtualGuestsWithUrchin", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualPrivateRack": { + "doc": "The bandwidth pooling for this account.", + "docOverview": "", + "name": "getVirtualPrivateRack", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getVirtualStorageArchiveRepositories": { + "doc": "An account's associated virtual server archived storage repositories.", + "docOverview": "", + "name": "getVirtualStorageArchiveRepositories", + "type": "SoftLayer_Virtual_Storage_Repository", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualStoragePublicRepositories": { + "doc": "An account's associated virtual server public storage repositories.", + "docOverview": "", + "name": "getVirtualStoragePublicRepositories", + "type": "SoftLayer_Virtual_Storage_Repository", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVpcVirtualGuests": { + "doc": "An account's associated VPC configured virtual guest objects.", + "docOverview": "", + "name": "getVpcVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVpnConfigRequiresVPNManageFlag": { + "doc": "", + "docOverview": "", + "name": "getVpnConfigRequiresVPNManageFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + } + }, + "typeDoc": "The SoftLayer_Account data type contains general information relating to a single SoftLayer customer account. Personal information in this type such as names, addresses, and phone numbers are assigned to the account only and not to users belonging to the account. The SoftLayer_Account data type contains a number of relational properties that are used by the SoftLayer customer portal to quickly present a variety of account related services to it's users. \n\nSoftLayer customers are unable to change their company account information in the portal or the API. If you need to change this information please open a sales ticket in our customer portal and our account management staff will assist you. ", + "properties": { + "abuseEmail": { + "name": "abuseEmail", + "type": "string", + "form": "relational", + "doc": "An email address that is responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to this address." + }, + "abuseEmails": { + "name": "abuseEmails", + "type": "SoftLayer_Account_AbuseEmail", + "form": "relational", + "typeArray": true, + "doc": "Email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses." + }, + "accountContacts": { + "name": "accountContacts", + "type": "SoftLayer_Account_Contact", + "form": "relational", + "typeArray": true, + "doc": "The account contacts on an account." + }, + "accountLicenses": { + "name": "accountLicenses", + "type": "SoftLayer_Software_AccountLicense", + "form": "relational", + "typeArray": true, + "doc": "The account software licenses owned by an account" + }, + "accountLinks": { + "name": "accountLinks", + "type": "SoftLayer_Account_Link", + "form": "relational", + "typeArray": true + }, + "accountStatus": { + "name": "accountStatus", + "type": "SoftLayer_Account_Status", + "form": "relational", + "doc": "An account's status presented in a more detailed data type." + }, + "activeAccountDiscountBillingItem": { + "name": "activeAccountDiscountBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "The billing item associated with an account's monthly discount." + }, + "activeAccountLicenses": { + "name": "activeAccountLicenses", + "type": "SoftLayer_Software_AccountLicense", + "form": "relational", + "typeArray": true, + "doc": "The active account software licenses owned by an account" + }, + "activeAddresses": { + "name": "activeAddresses", + "type": "SoftLayer_Account_Address", + "form": "relational", + "typeArray": true, + "doc": "The active address(es) that belong to an account." + }, + "activeAgreements": { + "name": "activeAgreements", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "typeArray": true, + "doc": "All active agreements for an account" + }, + "activeBillingAgreements": { + "name": "activeBillingAgreements", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "typeArray": true, + "doc": "All billing agreements for an account" + }, + "activeCatalystEnrollment": { + "name": "activeCatalystEnrollment", + "type": "SoftLayer_Catalyst_Enrollment", + "form": "relational" + }, + "activeColocationContainers": { + "name": "activeColocationContainers", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "Deprecated.", + "deprecated": true + }, + "activeFlexibleCreditEnrollment": { + "name": "activeFlexibleCreditEnrollment", + "type": "SoftLayer_FlexibleCredit_Enrollment", + "form": "relational", + "doc": "[Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments." + }, + "activeFlexibleCreditEnrollments": { + "name": "activeFlexibleCreditEnrollments", + "type": "SoftLayer_FlexibleCredit_Enrollment", + "form": "relational", + "typeArray": true + }, + "activeNotificationSubscribers": { + "name": "activeNotificationSubscribers", + "type": "SoftLayer_Notification_Subscriber", + "form": "relational", + "typeArray": true + }, + "activeQuotes": { + "name": "activeQuotes", + "type": "SoftLayer_Billing_Order_Quote", + "form": "relational", + "typeArray": true, + "doc": "An account's non-expired quotes." + }, + "activeReservedCapacityAgreements": { + "name": "activeReservedCapacityAgreements", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "typeArray": true, + "doc": "Active reserved capacity agreements for an account" + }, + "activeVirtualLicenses": { + "name": "activeVirtualLicenses", + "type": "SoftLayer_Software_VirtualLicense", + "form": "relational", + "typeArray": true, + "doc": "The virtual software licenses controlled by an account" + }, + "adcLoadBalancers": { + "name": "adcLoadBalancers", + "type": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress", + "form": "relational", + "typeArray": true, + "doc": "An account's associated load balancers." + }, + "addresses": { + "name": "addresses", + "type": "SoftLayer_Account_Address", + "form": "relational", + "typeArray": true, + "doc": "All the address(es) that belong to an account." + }, + "affiliateId": { + "name": "affiliateId", + "type": "string", + "form": "relational", + "doc": "An affiliate identifier associated with the customer account. " + }, + "allBillingItems": { + "name": "allBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The billing items that will be on an account's next invoice." + }, + "allCommissionBillingItems": { + "name": "allCommissionBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The billing items that will be on an account's next invoice." + }, + "allRecurringTopLevelBillingItems": { + "name": "allRecurringTopLevelBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The billing items that will be on an account's next invoice." + }, + "allRecurringTopLevelBillingItemsUnfiltered": { + "name": "allRecurringTopLevelBillingItemsUnfiltered", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The billing items that will be on an account's next invoice. Does not consider associated items." + }, + "allSubnetBillingItems": { + "name": "allSubnetBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The billing items that will be on an account's next invoice." + }, + "allTopLevelBillingItems": { + "name": "allTopLevelBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "All billing items of an account." + }, + "allTopLevelBillingItemsUnfiltered": { + "name": "allTopLevelBillingItemsUnfiltered", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The billing items that will be on an account's next invoice. Does not consider associated items." + }, + "allowIbmIdSilentMigrationFlag": { + "name": "allowIbmIdSilentMigrationFlag", + "type": "boolean", + "form": "relational", + "doc": "Indicates whether this account is allowed to silently migrate to use IBMid Authentication." + }, + "allowsBluemixAccountLinkingFlag": { + "name": "allowsBluemixAccountLinkingFlag", + "type": "boolean", + "form": "relational", + "doc": "Flag indicating if this account can be linked with Bluemix." + }, + "applicationDeliveryControllers": { + "name": "applicationDeliveryControllers", + "type": "SoftLayer_Network_Application_Delivery_Controller", + "form": "relational", + "typeArray": true, + "doc": "An account's associated application delivery controller records." + }, + "attributes": { + "name": "attributes", + "type": "SoftLayer_Account_Attribute", + "form": "relational", + "typeArray": true, + "doc": "The account attribute values for a SoftLayer customer account." + }, + "availablePublicNetworkVlans": { + "name": "availablePublicNetworkVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true, + "doc": "The public network VLANs assigned to an account." + }, + "balance": { + "name": "balance", + "type": "decimal", + "form": "relational", + "doc": "The account balance of a SoftLayer customer account. An account's balance is the amount of money owed to SoftLayer by the account holder, returned as a floating point number with two decimal places, measured in US Dollars ($USD). A negative account balance means the account holder has overpaid and is owed money by SoftLayer." + }, + "bandwidthAllotments": { + "name": "bandwidthAllotments", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "form": "relational", + "typeArray": true, + "doc": "The bandwidth allotments for an account." + }, + "bandwidthAllotmentsOverAllocation": { + "name": "bandwidthAllotmentsOverAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "form": "relational", + "typeArray": true, + "doc": "The bandwidth allotments for an account currently over allocation." + }, + "bandwidthAllotmentsProjectedOverAllocation": { + "name": "bandwidthAllotmentsProjectedOverAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "form": "relational", + "typeArray": true, + "doc": "The bandwidth allotments for an account projected to go over allocation." + }, + "bareMetalInstances": { + "name": "bareMetalInstances", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "An account's associated bare metal server objects." + }, + "billingAgreements": { + "name": "billingAgreements", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "typeArray": true, + "doc": "All billing agreements for an account" + }, + "billingInfo": { + "name": "billingInfo", + "type": "SoftLayer_Billing_Info", + "form": "relational", + "doc": "An account's billing information." + }, + "blockDeviceTemplateGroups": { + "name": "blockDeviceTemplateGroups", + "type": "SoftLayer_Virtual_Guest_Block_Device_Template_Group", + "form": "relational", + "typeArray": true, + "doc": "Private template group objects (parent and children) and the shared template group objects (parent only) for an account." + }, + "blockSelfServiceBrandMigration": { + "name": "blockSelfServiceBrandMigration", + "type": "boolean", + "form": "relational", + "doc": "Flag indicating whether this account is restricted from performing a self-service brand migration by updating their credit card details." + }, + "bluemixAccountId": { + "name": "bluemixAccountId", + "type": "string", + "form": "relational" + }, + "bluemixAccountLink": { + "name": "bluemixAccountLink", + "type": "SoftLayer_Account_Link_Bluemix", + "form": "relational", + "doc": "The Platform account link associated with this SoftLayer account, if one exists." + }, + "bluemixLinkedFlag": { + "name": "bluemixLinkedFlag", + "type": "boolean", + "form": "relational", + "doc": "Returns true if this account is linked to IBM Bluemix, false if not." + }, + "brand": { + "name": "brand", + "type": "SoftLayer_Brand", + "form": "relational" + }, + "brandAccountFlag": { + "name": "brandAccountFlag", + "type": "boolean", + "form": "relational" + }, + "brandKeyName": { + "name": "brandKeyName", + "type": "string", + "form": "relational", + "doc": "The brand keyName." + }, + "businessPartner": { + "name": "businessPartner", + "type": "SoftLayer_Account_Business_Partner", + "form": "relational", + "doc": "The Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level." + }, + "canOrderAdditionalVlansFlag": { + "name": "canOrderAdditionalVlansFlag", + "type": "boolean", + "form": "relational", + "doc": "[DEPRECATED] All accounts may order VLANs.", + "deprecated": true + }, + "carts": { + "name": "carts", + "type": "SoftLayer_Billing_Order_Quote", + "form": "relational", + "typeArray": true, + "doc": "An account's active carts." + }, + "catalystEnrollments": { + "name": "catalystEnrollments", + "type": "SoftLayer_Catalyst_Enrollment", + "form": "relational", + "typeArray": true + }, + "closedTickets": { + "name": "closedTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "All closed tickets associated with an account." + }, + "datacentersWithSubnetAllocations": { + "name": "datacentersWithSubnetAllocations", + "type": "SoftLayer_Location", + "form": "relational", + "typeArray": true, + "doc": "Datacenters which contain subnets that the account has access to route." + }, + "dedicatedHosts": { + "name": "dedicatedHosts", + "type": "SoftLayer_Virtual_DedicatedHost", + "form": "relational", + "typeArray": true, + "doc": "An account's associated virtual dedicated host objects." + }, + "disablePaymentProcessingFlag": { + "name": "disablePaymentProcessingFlag", + "type": "boolean", + "form": "relational", + "doc": "A flag indicating whether payments are processed for this account." + }, + "displaySupportRepresentativeAssignments": { + "name": "displaySupportRepresentativeAssignments", + "type": "SoftLayer_Account_Attachment_Employee", + "form": "relational", + "typeArray": true, + "doc": "The SoftLayer employees that an account is assigned to." + }, + "domains": { + "name": "domains", + "type": "SoftLayer_Dns_Domain", + "form": "relational", + "typeArray": true, + "doc": "The DNS domains associated with an account." + }, + "domainsWithoutSecondaryDnsRecords": { + "name": "domainsWithoutSecondaryDnsRecords", + "type": "SoftLayer_Dns_Domain", + "form": "relational", + "typeArray": true, + "doc": "The DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer." + }, + "euSupportedFlag": { + "name": "euSupportedFlag", + "type": "boolean", + "form": "relational", + "doc": "Boolean flag dictating whether or not this account has the EU Supported flag. This flag indicates that this account uses IBM Cloud services to process EU citizen's personal data." + }, + "evaultCapacityGB": { + "name": "evaultCapacityGB", + "type": "unsignedInt", + "form": "relational", + "doc": "The total capacity of Legacy EVault Volumes on an account, in GB." + }, + "evaultMasterUsers": { + "name": "evaultMasterUsers", + "type": "SoftLayer_Account_Password", + "form": "relational", + "typeArray": true, + "doc": "An account's master EVault user. This is only used when an account has EVault service." + }, + "evaultNetworkStorage": { + "name": "evaultNetworkStorage", + "type": "SoftLayer_Network_Storage", + "form": "relational", + "typeArray": true, + "doc": "An account's associated EVault storage volumes." + }, + "expiredSecurityCertificates": { + "name": "expiredSecurityCertificates", + "type": "SoftLayer_Security_Certificate", + "form": "relational", + "typeArray": true, + "doc": "Stored security certificates that are expired (ie. SSL)" + }, + "facilityLogs": { + "name": "facilityLogs", + "type": "SoftLayer_User_Access_Facility_Log", + "form": "relational", + "typeArray": true, + "doc": "Logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter." + }, + "fileBlockBetaAccessFlag": { + "name": "fileBlockBetaAccessFlag", + "type": "boolean", + "form": "relational" + }, + "flexibleCreditEnrollments": { + "name": "flexibleCreditEnrollments", + "type": "SoftLayer_FlexibleCredit_Enrollment", + "form": "relational", + "typeArray": true, + "doc": "All of the account's current and former Flexible Credit enrollments." + }, + "forcePaasAccountLinkDate": { + "name": "forcePaasAccountLinkDate", + "type": "string", + "form": "relational", + "doc": "Timestamp representing the point in time when an account is required to link with PaaS." + }, + "globalIpRecords": { + "name": "globalIpRecords", + "type": "SoftLayer_Network_Subnet_IpAddress_Global", + "form": "relational", + "typeArray": true + }, + "globalIpv4Records": { + "name": "globalIpv4Records", + "type": "SoftLayer_Network_Subnet_IpAddress_Global", + "form": "relational", + "typeArray": true + }, + "globalIpv6Records": { + "name": "globalIpv6Records", + "type": "SoftLayer_Network_Subnet_IpAddress_Global", + "form": "relational", + "typeArray": true + }, + "hardware": { + "name": "hardware", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "An account's associated hardware objects." + }, + "hardwareOverBandwidthAllocation": { + "name": "hardwareOverBandwidthAllocation", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "An account's associated hardware objects currently over bandwidth allocation." + }, + "hardwareProjectedOverBandwidthAllocation": { + "name": "hardwareProjectedOverBandwidthAllocation", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "An account's associated hardware objects projected to go over bandwidth allocation." + }, + "hardwareWithCpanel": { + "name": "hardwareWithCpanel", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All hardware associated with an account that has the cPanel web hosting control panel installed." + }, + "hardwareWithHelm": { + "name": "hardwareWithHelm", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All hardware associated with an account that has the Helm web hosting control panel installed." + }, + "hardwareWithMcafee": { + "name": "hardwareWithMcafee", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All hardware associated with an account that has McAfee Secure software components." + }, + "hardwareWithMcafeeAntivirusRedhat": { + "name": "hardwareWithMcafeeAntivirusRedhat", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components." + }, + "hardwareWithMcafeeAntivirusWindows": { + "name": "hardwareWithMcafeeAntivirusWindows", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All hardware associated with an account that has McAfee Secure AntiVirus for Windows software components." + }, + "hardwareWithMcafeeIntrusionDetectionSystem": { + "name": "hardwareWithMcafeeIntrusionDetectionSystem", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All hardware associated with an account that has McAfee Secure Intrusion Detection System software components." + }, + "hardwareWithPlesk": { + "name": "hardwareWithPlesk", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All hardware associated with an account that has the Plesk web hosting control panel installed." + }, + "hardwareWithQuantastor": { + "name": "hardwareWithQuantastor", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All hardware associated with an account that has the QuantaStor storage system installed." + }, + "hardwareWithUrchin": { + "name": "hardwareWithUrchin", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All hardware associated with an account that has the Urchin web traffic analytics package installed." + }, + "hardwareWithWindows": { + "name": "hardwareWithWindows", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All hardware associated with an account that is running a version of the Microsoft Windows operating system." + }, + "hasEvaultBareMetalRestorePluginFlag": { + "name": "hasEvaultBareMetalRestorePluginFlag", + "type": "boolean", + "form": "relational", + "doc": "Return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0." + }, + "hasIderaBareMetalRestorePluginFlag": { + "name": "hasIderaBareMetalRestorePluginFlag", + "type": "boolean", + "form": "relational", + "doc": "Return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0." + }, + "hasPendingOrder": { + "name": "hasPendingOrder", + "type": "unsignedInt", + "form": "relational", + "doc": "The number of orders in a PENDING status for a SoftLayer customer account." + }, + "hasR1softBareMetalRestorePluginFlag": { + "name": "hasR1softBareMetalRestorePluginFlag", + "type": "boolean", + "form": "relational", + "doc": "Return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0." + }, + "hourlyBareMetalInstances": { + "name": "hourlyBareMetalInstances", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "An account's associated hourly bare metal server objects." + }, + "hourlyServiceBillingItems": { + "name": "hourlyServiceBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "Hourly service billing items that will be on an account's next invoice." + }, + "hourlyVirtualGuests": { + "name": "hourlyVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "An account's associated hourly virtual guest objects." + }, + "hubNetworkStorage": { + "name": "hubNetworkStorage", + "type": "SoftLayer_Network_Storage", + "form": "relational", + "typeArray": true, + "doc": "An account's associated Virtual Storage volumes." + }, + "ibmCustomerNumber": { + "name": "ibmCustomerNumber", + "type": "string", + "form": "relational", + "doc": "Unique identifier for a customer used throughout IBM." + }, + "ibmIdAuthenticationRequiredFlag": { + "name": "ibmIdAuthenticationRequiredFlag", + "type": "boolean", + "form": "relational", + "doc": "Indicates whether this account requires IBMid authentication." + }, + "ibmIdMigrationExpirationTimestamp": { + "name": "ibmIdMigrationExpirationTimestamp", + "type": "string", + "form": "relational", + "doc": "This key is deprecated and should not be used." + }, + "inProgressExternalAccountSetup": { + "name": "inProgressExternalAccountSetup", + "type": "SoftLayer_Account_External_Setup", + "form": "relational", + "doc": "An in progress request to switch billing systems." + }, + "internalCciHostAccountFlag": { + "name": "internalCciHostAccountFlag", + "type": "boolean", + "form": "relational", + "doc": "Account attribute flag indicating internal cci host account." + }, + "internalImageTemplateCreationFlag": { + "name": "internalImageTemplateCreationFlag", + "type": "boolean", + "form": "relational", + "doc": "Account attribute flag indicating account creates internal image templates." + }, + "internalNotes": { + "name": "internalNotes", + "type": "SoftLayer_Account_Note", + "form": "relational", + "typeArray": true + }, + "internalRestrictionFlag": { + "name": "internalRestrictionFlag", + "type": "boolean", + "form": "relational", + "doc": "Account attribute flag indicating restricted account." + }, + "invoices": { + "name": "invoices", + "type": "SoftLayer_Billing_Invoice", + "form": "relational", + "typeArray": true, + "doc": "An account's associated billing invoices." + }, + "ipAddresses": { + "name": "ipAddresses", + "type": "SoftLayer_Network_Subnet_IpAddress", + "form": "relational", + "typeArray": true + }, + "iscsiIsolationDisabled": { + "name": "iscsiIsolationDisabled", + "type": "boolean", + "form": "relational" + }, + "iscsiNetworkStorage": { + "name": "iscsiNetworkStorage", + "type": "SoftLayer_Network_Storage", + "form": "relational", + "typeArray": true, + "doc": "An account's associated iSCSI storage volumes." + }, + "lastCanceledBillingItem": { + "name": "lastCanceledBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "The most recently canceled billing item." + }, + "lastCancelledServerBillingItem": { + "name": "lastCancelledServerBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "The most recent cancelled server billing item." + }, + "lastFiveClosedAbuseTickets": { + "name": "lastFiveClosedAbuseTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The five most recently closed abuse tickets associated with an account." + }, + "lastFiveClosedAccountingTickets": { + "name": "lastFiveClosedAccountingTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The five most recently closed accounting tickets associated with an account." + }, + "lastFiveClosedOtherTickets": { + "name": "lastFiveClosedOtherTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account." + }, + "lastFiveClosedSalesTickets": { + "name": "lastFiveClosedSalesTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The five most recently closed sales tickets associated with an account." + }, + "lastFiveClosedSupportTickets": { + "name": "lastFiveClosedSupportTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The five most recently closed support tickets associated with an account." + }, + "lastFiveClosedTickets": { + "name": "lastFiveClosedTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The five most recently closed tickets associated with an account." + }, + "latestBillDate": { + "name": "latestBillDate", + "type": "dateTime", + "form": "relational", + "doc": "An account's most recent billing date." + }, + "latestRecurringInvoice": { + "name": "latestRecurringInvoice", + "type": "SoftLayer_Billing_Invoice", + "form": "relational", + "doc": "An account's latest recurring invoice." + }, + "latestRecurringPendingInvoice": { + "name": "latestRecurringPendingInvoice", + "type": "SoftLayer_Billing_Invoice", + "form": "relational", + "doc": "An account's latest recurring pending invoice." + }, + "legacyIscsiCapacityGB": { + "name": "legacyIscsiCapacityGB", + "type": "unsignedInt", + "form": "relational", + "doc": "The total capacity of Legacy iSCSI Volumes on an account, in GB." + }, + "loadBalancers": { + "name": "loadBalancers", + "type": "SoftLayer_Network_LoadBalancer_VirtualIpAddress", + "form": "relational", + "typeArray": true, + "doc": "An account's associated load balancers." + }, + "lockboxCapacityGB": { + "name": "lockboxCapacityGB", + "type": "unsignedInt", + "form": "relational", + "doc": "The total capacity of Legacy lockbox Volumes on an account, in GB." + }, + "lockboxNetworkStorage": { + "name": "lockboxNetworkStorage", + "type": "SoftLayer_Network_Storage", + "form": "relational", + "typeArray": true, + "doc": "An account's associated Lockbox storage volumes." + }, + "manualPaymentsUnderReview": { + "name": "manualPaymentsUnderReview", + "type": "SoftLayer_Billing_Payment_Card_ManualPayment", + "form": "relational", + "typeArray": true + }, + "masterUser": { + "name": "masterUser", + "type": "SoftLayer_User_Customer", + "form": "relational", + "doc": "An account's master user." + }, + "mediaDataTransferRequests": { + "name": "mediaDataTransferRequests", + "type": "SoftLayer_Account_Media_Data_Transfer_Request", + "form": "relational", + "typeArray": true, + "doc": "An account's media transfer service requests." + }, + "migratedToIbmCloudPortalFlag": { + "name": "migratedToIbmCloudPortalFlag", + "type": "boolean", + "form": "relational", + "doc": "Flag indicating whether this account is restricted to the IBM Cloud portal." + }, + "monthlyBareMetalInstances": { + "name": "monthlyBareMetalInstances", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "An account's associated monthly bare metal server objects." + }, + "monthlyVirtualGuests": { + "name": "monthlyVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "An account's associated monthly virtual guest objects." + }, + "nasNetworkStorage": { + "name": "nasNetworkStorage", + "type": "SoftLayer_Network_Storage", + "form": "relational", + "typeArray": true, + "doc": "An account's associated NAS storage volumes." + }, + "networkCreationFlag": { + "name": "networkCreationFlag", + "type": "boolean", + "form": "relational", + "doc": "[Deprecated] Whether or not this account can define their own networks." + }, + "networkGateways": { + "name": "networkGateways", + "type": "SoftLayer_Network_Gateway", + "form": "relational", + "typeArray": true, + "doc": "All network gateway devices on this account." + }, + "networkHardware": { + "name": "networkHardware", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "An account's associated network hardware." + }, + "networkMessageDeliveryAccounts": { + "name": "networkMessageDeliveryAccounts", + "type": "SoftLayer_Network_Message_Delivery", + "form": "relational", + "typeArray": true + }, + "networkMonitorDownHardware": { + "name": "networkMonitorDownHardware", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "Hardware which is currently experiencing a service failure." + }, + "networkMonitorDownVirtualGuests": { + "name": "networkMonitorDownVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "Virtual guest which is currently experiencing a service failure." + }, + "networkMonitorRecoveringHardware": { + "name": "networkMonitorRecoveringHardware", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "Hardware which is currently recovering from a service failure." + }, + "networkMonitorRecoveringVirtualGuests": { + "name": "networkMonitorRecoveringVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "Virtual guest which is currently recovering from a service failure." + }, + "networkMonitorUpHardware": { + "name": "networkMonitorUpHardware", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "Hardware which is currently online." + }, + "networkMonitorUpVirtualGuests": { + "name": "networkMonitorUpVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "Virtual guest which is currently online." + }, + "networkStorage": { + "name": "networkStorage", + "type": "SoftLayer_Network_Storage", + "form": "relational", + "typeArray": true, + "doc": "An account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes." + }, + "networkStorageGroups": { + "name": "networkStorageGroups", + "type": "SoftLayer_Network_Storage_Group", + "form": "relational", + "typeArray": true, + "doc": "An account's Network Storage groups." + }, + "networkTunnelContexts": { + "name": "networkTunnelContexts", + "type": "SoftLayer_Network_Tunnel_Module_Context", + "form": "relational", + "typeArray": true, + "doc": "IPSec network tunnels for an account." + }, + "networkVlanSpan": { + "name": "networkVlanSpan", + "type": "SoftLayer_Account_Network_Vlan_Span", + "form": "relational", + "doc": "Whether or not an account has automatic private VLAN spanning enabled." + }, + "networkVlans": { + "name": "networkVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true, + "doc": "All network VLANs assigned to an account." + }, + "nextInvoiceIncubatorExemptTotal": { + "name": "nextInvoiceIncubatorExemptTotal", + "type": "decimal", + "form": "relational", + "doc": "The pre-tax total amount exempt from incubator credit for the account's next invoice. This field is now deprecated and will soon be removed. Please update all references to instead use nextInvoiceTotalAmount" + }, + "nextInvoicePlatformServicesTotalAmount": { + "name": "nextInvoicePlatformServicesTotalAmount", + "type": "decimal", + "form": "relational", + "doc": "The pre-tax platform services total amount of an account's next invoice." + }, + "nextInvoiceRecurringAmountEligibleForAccountDiscount": { + "name": "nextInvoiceRecurringAmountEligibleForAccountDiscount", + "type": "decimal", + "form": "relational", + "doc": "The total recurring charge amount of an account's next invoice eligible for account discount measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing." + }, + "nextInvoiceTopLevelBillingItems": { + "name": "nextInvoiceTopLevelBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The billing items that will be on an account's next invoice." + }, + "nextInvoiceTotalAmount": { + "name": "nextInvoiceTotalAmount", + "type": "float", + "form": "relational", + "doc": "The pre-tax total amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing." + }, + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", + "type": "decimal", + "form": "relational", + "doc": "The total one-time charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing." + }, + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", + "type": "decimal", + "form": "relational", + "doc": "The total one-time tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing." + }, + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", + "type": "decimal", + "form": "relational", + "doc": "The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing." + }, + "nextInvoiceTotalRecurringAmountBeforeAccountDiscount": { + "name": "nextInvoiceTotalRecurringAmountBeforeAccountDiscount", + "type": "decimal", + "form": "relational", + "doc": "The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing." + }, + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", + "type": "float", + "form": "relational", + "doc": "The total recurring tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing." + }, + "nextInvoiceTotalTaxableRecurringAmount": { + "name": "nextInvoiceTotalTaxableRecurringAmount", + "type": "decimal", + "form": "relational", + "doc": "The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing." + }, + "notificationSubscribers": { + "name": "notificationSubscribers", + "type": "SoftLayer_Notification_Subscriber", + "form": "relational", + "typeArray": true + }, + "openAbuseTickets": { + "name": "openAbuseTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The open abuse tickets associated with an account." + }, + "openAccountingTickets": { + "name": "openAccountingTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The open accounting tickets associated with an account." + }, + "openBillingTickets": { + "name": "openBillingTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The open billing tickets associated with an account." + }, + "openCancellationRequests": { + "name": "openCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "An open ticket requesting cancellation of this server, if one exists." + }, + "openOtherTickets": { + "name": "openOtherTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account." + }, + "openRecurringInvoices": { + "name": "openRecurringInvoices", + "type": "SoftLayer_Billing_Invoice", + "form": "relational", + "typeArray": true, + "doc": "An account's recurring invoices." + }, + "openSalesTickets": { + "name": "openSalesTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The open sales tickets associated with an account." + }, + "openStackAccountLinks": { + "name": "openStackAccountLinks", + "type": "SoftLayer_Account_Link", + "form": "relational", + "typeArray": true + }, + "openStackObjectStorage": { + "name": "openStackObjectStorage", + "type": "SoftLayer_Network_Storage", + "form": "relational", + "typeArray": true, + "doc": "An account's associated Openstack related Object Storage accounts." + }, + "openSupportTickets": { + "name": "openSupportTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "The open support tickets associated with an account." + }, + "openTickets": { + "name": "openTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "All open tickets associated with an account." + }, + "openTicketsWaitingOnCustomer": { + "name": "openTicketsWaitingOnCustomer", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "All open tickets associated with an account last edited by an employee." + }, + "orders": { + "name": "orders", + "type": "SoftLayer_Billing_Order", + "form": "relational", + "typeArray": true, + "doc": "An account's associated billing orders excluding upgrades." + }, + "orphanBillingItems": { + "name": "orphanBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The billing items that have no parent billing item. These are items that don't necessarily belong to a single server." + }, + "ownedBrands": { + "name": "ownedBrands", + "type": "SoftLayer_Brand", + "form": "relational", + "typeArray": true + }, + "ownedHardwareGenericComponentModels": { + "name": "ownedHardwareGenericComponentModels", + "type": "SoftLayer_Hardware_Component_Model_Generic", + "form": "relational", + "typeArray": true + }, + "paymentProcessors": { + "name": "paymentProcessors", + "type": "SoftLayer_Billing_Payment_Processor", + "form": "relational", + "typeArray": true + }, + "pendingEvents": { + "name": "pendingEvents", + "type": "SoftLayer_Notification_Occurrence_Event", + "form": "relational", + "typeArray": true + }, + "pendingInvoice": { + "name": "pendingInvoice", + "type": "SoftLayer_Billing_Invoice", + "form": "relational", + "doc": "An account's latest open (pending) invoice." + }, + "pendingInvoiceTopLevelItems": { + "name": "pendingInvoiceTopLevelItems", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "typeArray": true, + "doc": "A list of top-level invoice items that are on an account's currently pending invoice." + }, + "pendingInvoiceTotalAmount": { + "name": "pendingInvoiceTotalAmount", + "type": "decimal", + "form": "relational", + "doc": "The total amount of an account's pending invoice, if one exists." + }, + "pendingInvoiceTotalOneTimeAmount": { + "name": "pendingInvoiceTotalOneTimeAmount", + "type": "decimal", + "form": "relational", + "doc": "The total one-time charges for an account's pending invoice, if one exists. In other words, it is the sum of one-time charges, setup fees, and labor fees. It does not include taxes." + }, + "pendingInvoiceTotalOneTimeTaxAmount": { + "name": "pendingInvoiceTotalOneTimeTaxAmount", + "type": "decimal", + "form": "relational", + "doc": "The sum of all the taxes related to one time charges for an account's pending invoice, if one exists." + }, + "pendingInvoiceTotalRecurringAmount": { + "name": "pendingInvoiceTotalRecurringAmount", + "type": "decimal", + "form": "relational", + "doc": "The total recurring amount of an account's pending invoice, if one exists." + }, + "pendingInvoiceTotalRecurringTaxAmount": { + "name": "pendingInvoiceTotalRecurringTaxAmount", + "type": "decimal", + "form": "relational", + "doc": "The total amount of the recurring taxes on an account's pending invoice, if one exists." + }, + "permissionGroups": { + "name": "permissionGroups", + "type": "SoftLayer_User_Permission_Group", + "form": "relational", + "typeArray": true, + "doc": "An account's permission groups." + }, + "permissionRoles": { + "name": "permissionRoles", + "type": "SoftLayer_User_Permission_Role", + "form": "relational", + "typeArray": true, + "doc": "An account's user roles." + }, + "placementGroups": { + "name": "placementGroups", + "type": "SoftLayer_Virtual_PlacementGroup", + "form": "relational", + "typeArray": true, + "doc": "An account's associated virtual placement groups." + }, + "portableStorageVolumes": { + "name": "portableStorageVolumes", + "type": "SoftLayer_Virtual_Disk_Image", + "form": "relational", + "typeArray": true + }, + "postProvisioningHooks": { + "name": "postProvisioningHooks", + "type": "SoftLayer_Provisioning_Hook", + "form": "relational", + "typeArray": true, + "doc": "Customer specified URIs that are downloaded onto a newly provisioned or reloaded server. If the URI is sent over https it will be executed directly on the server." + }, + "pptpVpnAllowedFlag": { + "name": "pptpVpnAllowedFlag", + "type": "boolean", + "form": "relational", + "doc": "(Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access." + }, + "pptpVpnUsers": { + "name": "pptpVpnUsers", + "type": "SoftLayer_User_Customer", + "form": "relational", + "typeArray": true, + "doc": "An account's associated portal users with PPTP VPN access. (Deprecated)" + }, + "preOpenRecurringInvoices": { + "name": "preOpenRecurringInvoices", + "type": "SoftLayer_Billing_Invoice", + "form": "relational", + "typeArray": true, + "doc": "An account's invoices in the PRE_OPEN status." + }, + "previousRecurringRevenue": { + "name": "previousRecurringRevenue", + "type": "decimal", + "form": "relational", + "doc": "The total recurring amount for an accounts previous revenue." + }, + "priceRestrictions": { + "name": "priceRestrictions", + "type": "SoftLayer_Product_Item_Price_Account_Restriction", + "form": "relational", + "typeArray": true, + "doc": "The item price that an account is restricted to." + }, + "priorityOneTickets": { + "name": "priorityOneTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "All priority one tickets associated with an account." + }, + "privateBlockDeviceTemplateGroups": { + "name": "privateBlockDeviceTemplateGroups", + "type": "SoftLayer_Virtual_Guest_Block_Device_Template_Group", + "form": "relational", + "typeArray": true, + "doc": "Private and shared template group objects (parent only) for an account." + }, + "privateIpAddresses": { + "name": "privateIpAddresses", + "type": "SoftLayer_Network_Subnet_IpAddress", + "form": "relational", + "typeArray": true + }, + "privateNetworkVlans": { + "name": "privateNetworkVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true, + "doc": "The private network VLANs assigned to an account." + }, + "privateSubnets": { + "name": "privateSubnets", + "type": "SoftLayer_Network_Subnet", + "form": "relational", + "typeArray": true, + "doc": "All private subnets associated with an account." + }, + "proofOfConceptAccountFlag": { + "name": "proofOfConceptAccountFlag", + "type": "boolean", + "form": "relational", + "doc": "Boolean flag indicating whether or not this account is a Proof of Concept account." + }, + "publicIpAddresses": { + "name": "publicIpAddresses", + "type": "SoftLayer_Network_Subnet_IpAddress", + "form": "relational", + "typeArray": true + }, + "publicNetworkVlans": { + "name": "publicNetworkVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true, + "doc": "The public network VLANs assigned to an account." + }, + "publicSubnets": { + "name": "publicSubnets", + "type": "SoftLayer_Network_Subnet", + "form": "relational", + "typeArray": true, + "doc": "All public network subnets associated with an account." + }, + "quotes": { + "name": "quotes", + "type": "SoftLayer_Billing_Order_Quote", + "form": "relational", + "typeArray": true, + "doc": "An account's quotes." + }, + "recentEvents": { + "name": "recentEvents", + "type": "SoftLayer_Notification_Occurrence_Event", + "form": "relational", + "typeArray": true + }, + "referralPartner": { + "name": "referralPartner", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The Referral Partner for this account, if any." + }, + "referredAccountFlag": { + "name": "referredAccountFlag", + "type": "boolean", + "form": "relational", + "doc": "Flag indicating if the account was referred." + }, + "referredAccounts": { + "name": "referredAccounts", + "type": "SoftLayer_Account", + "form": "relational", + "typeArray": true, + "doc": "If this is a account is a referral partner, the accounts this referral partner has referred" + }, + "regulatedWorkloads": { + "name": "regulatedWorkloads", + "type": "SoftLayer_Legal_RegulatedWorkload", + "form": "relational", + "typeArray": true + }, + "remoteManagementCommandRequests": { + "name": "remoteManagementCommandRequests", + "type": "SoftLayer_Hardware_Component_RemoteManagement_Command_Request", + "form": "relational", + "typeArray": true, + "doc": "Remote management command requests for an account" + }, + "replicationEvents": { + "name": "replicationEvents", + "type": "SoftLayer_Network_Storage_Event", + "form": "relational", + "typeArray": true, + "doc": "The Replication events for all Network Storage volumes on an account." + }, + "requireSilentIBMidUserCreation": { + "name": "requireSilentIBMidUserCreation", + "type": "boolean", + "form": "relational", + "doc": "Indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not." + }, + "reservedCapacityAgreements": { + "name": "reservedCapacityAgreements", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "typeArray": true, + "doc": "All reserved capacity agreements for an account" + }, + "reservedCapacityGroups": { + "name": "reservedCapacityGroups", + "type": "SoftLayer_Virtual_ReservedCapacityGroup", + "form": "relational", + "typeArray": true, + "doc": "The reserved capacity groups owned by this account." + }, + "routers": { + "name": "routers", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "All Routers that an accounts VLANs reside on" + }, + "rwhoisData": { + "name": "rwhoisData", + "type": "SoftLayer_Network_Subnet_Rwhois_Data", + "form": "relational", + "typeArray": true, + "doc": "DEPRECATED", + "deprecated": true + }, + "samlAuthentication": { + "name": "samlAuthentication", + "type": "SoftLayer_Account_Authentication_Saml", + "form": "relational", + "doc": "The SAML configuration for this account." + }, + "secondaryDomains": { + "name": "secondaryDomains", + "type": "SoftLayer_Dns_Secondary", + "form": "relational", + "typeArray": true, + "doc": "The secondary DNS records for a SoftLayer customer account." + }, + "securityCertificates": { + "name": "securityCertificates", + "type": "SoftLayer_Security_Certificate", + "form": "relational", + "typeArray": true, + "doc": "Stored security certificates (ie. SSL)" + }, + "securityGroups": { + "name": "securityGroups", + "type": "SoftLayer_Network_SecurityGroup", + "form": "relational", + "typeArray": true, + "doc": "The security groups belonging to this account." + }, + "securityLevel": { + "name": "securityLevel", + "type": "SoftLayer_Security_Level", + "form": "relational" + }, + "securityScanRequests": { + "name": "securityScanRequests", + "type": "SoftLayer_Network_Security_Scanner_Request", + "form": "relational", + "typeArray": true, + "doc": "An account's vulnerability scan requests." + }, + "serviceBillingItems": { + "name": "serviceBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The service billing items that will be on an account's next invoice. " + }, + "shipments": { + "name": "shipments", + "type": "SoftLayer_Account_Shipment", + "form": "relational", + "typeArray": true, + "doc": "Shipments that belong to the customer's account." + }, + "sshKeys": { + "name": "sshKeys", + "type": "SoftLayer_Security_Ssh_Key", + "form": "relational", + "typeArray": true, + "doc": "Customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server." + }, + "sslVpnUsers": { + "name": "sslVpnUsers", + "type": "SoftLayer_User_Customer", + "form": "relational", + "typeArray": true, + "doc": "An account's associated portal users with SSL VPN access." + }, + "standardPoolVirtualGuests": { + "name": "standardPoolVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "An account's virtual guest objects that are hosted on a user provisioned hypervisor." + }, + "subnetRegistrationDetails": { + "name": "subnetRegistrationDetails", + "type": "SoftLayer_Account_Regional_Registry_Detail", + "form": "relational", + "typeArray": true, + "deprecated": true + }, + "subnetRegistrations": { + "name": "subnetRegistrations", + "type": "SoftLayer_Network_Subnet_Registration", + "form": "relational", + "typeArray": true, + "deprecated": true + }, + "subnets": { + "name": "subnets", + "type": "SoftLayer_Network_Subnet", + "form": "relational", + "typeArray": true, + "doc": "All network subnets associated with an account." + }, + "supportRepresentatives": { + "name": "supportRepresentatives", + "type": "SoftLayer_User_Employee", + "form": "relational", + "typeArray": true, + "doc": "The SoftLayer employees that an account is assigned to." + }, + "supportSubscriptions": { + "name": "supportSubscriptions", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The active support subscriptions for this account." + }, + "supportTier": { + "name": "supportTier", + "type": "string", + "form": "relational" + }, + "suppressInvoicesFlag": { + "name": "suppressInvoicesFlag", + "type": "boolean", + "form": "relational", + "doc": "A flag indicating to suppress invoices." + }, + "tags": { + "name": "tags", + "type": "SoftLayer_Tag", + "form": "relational", + "typeArray": true + }, + "testAccountAttributeFlag": { + "name": "testAccountAttributeFlag", + "type": "boolean", + "form": "relational", + "doc": "Account attribute flag indicating test account." + }, + "tickets": { + "name": "tickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "An account's associated tickets." + }, + "ticketsClosedInTheLastThreeDays": { + "name": "ticketsClosedInTheLastThreeDays", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "Tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account." + }, + "ticketsClosedToday": { + "name": "ticketsClosedToday", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true, + "doc": "Tickets closed today associated with an account." + }, + "upgradeRequests": { + "name": "upgradeRequests", + "type": "SoftLayer_Product_Upgrade_Request", + "form": "relational", + "typeArray": true, + "doc": "An account's associated upgrade requests." + }, + "users": { + "name": "users", + "type": "SoftLayer_User_Customer", + "form": "relational", + "typeArray": true, + "doc": "An account's portal users." + }, + "validSecurityCertificates": { + "name": "validSecurityCertificates", + "type": "SoftLayer_Security_Certificate", + "form": "relational", + "typeArray": true, + "doc": "Stored security certificates that are not expired (ie. SSL)" + }, + "virtualDedicatedRacks": { + "name": "virtualDedicatedRacks", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "form": "relational", + "typeArray": true, + "doc": "The bandwidth pooling for this account." + }, + "virtualDiskImages": { + "name": "virtualDiskImages", + "type": "SoftLayer_Virtual_Disk_Image", + "form": "relational", + "typeArray": true, + "doc": "An account's associated virtual server virtual disk images." + }, + "virtualGuests": { + "name": "virtualGuests", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "An account's associated virtual guest objects." + }, + "virtualGuestsOverBandwidthAllocation": { + "name": "virtualGuestsOverBandwidthAllocation", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "An account's associated virtual guest objects currently over bandwidth allocation." + }, + "virtualGuestsProjectedOverBandwidthAllocation": { + "name": "virtualGuestsProjectedOverBandwidthAllocation", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "An account's associated virtual guest objects currently over bandwidth allocation." + }, + "virtualGuestsWithCpanel": { + "name": "virtualGuestsWithCpanel", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "All virtual guests associated with an account that has the cPanel web hosting control panel installed." + }, + "virtualGuestsWithMcafee": { + "name": "virtualGuestsWithMcafee", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "All virtual guests associated with an account that have McAfee Secure software components." + }, + "virtualGuestsWithMcafeeAntivirusRedhat": { + "name": "virtualGuestsWithMcafeeAntivirusRedhat", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "All virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components." + }, + "virtualGuestsWithMcafeeAntivirusWindows": { + "name": "virtualGuestsWithMcafeeAntivirusWindows", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "All virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components." + }, + "virtualGuestsWithMcafeeIntrusionDetectionSystem": { + "name": "virtualGuestsWithMcafeeIntrusionDetectionSystem", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "All virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components." + }, + "virtualGuestsWithPlesk": { + "name": "virtualGuestsWithPlesk", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "All virtual guests associated with an account that has the Plesk web hosting control panel installed." + }, + "virtualGuestsWithQuantastor": { + "name": "virtualGuestsWithQuantastor", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "All virtual guests associated with an account that have the QuantaStor storage system installed." + }, + "virtualGuestsWithUrchin": { + "name": "virtualGuestsWithUrchin", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "All virtual guests associated with an account that has the Urchin web traffic analytics package installed." + }, + "virtualPrivateRack": { + "name": "virtualPrivateRack", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "form": "relational", + "doc": "The bandwidth pooling for this account." + }, + "virtualStorageArchiveRepositories": { + "name": "virtualStorageArchiveRepositories", + "type": "SoftLayer_Virtual_Storage_Repository", + "form": "relational", + "typeArray": true, + "doc": "An account's associated virtual server archived storage repositories." + }, + "virtualStoragePublicRepositories": { + "name": "virtualStoragePublicRepositories", + "type": "SoftLayer_Virtual_Storage_Repository", + "form": "relational", + "typeArray": true, + "doc": "An account's associated virtual server public storage repositories." + }, + "vpcVirtualGuests": { + "name": "vpcVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "An account's associated VPC configured virtual guest objects." + }, + "vpnConfigRequiresVPNManageFlag": { + "name": "vpnConfigRequiresVPNManageFlag", + "type": "boolean", + "form": "relational" + }, + "accountManagedResourcesFlag": { + "name": "accountManagedResourcesFlag", + "type": "boolean", + "form": "local", + "doc": "A flag indicating that the account has a managed resource." + }, + "accountStatusId": { + "name": "accountStatusId", + "type": "int", + "form": "local", + "doc": "A number reflecting the state of an account." + }, + "address1": { + "name": "address1", + "type": "string", + "form": "local", + "doc": "The first line of the mailing address belonging to an account." + }, + "address2": { + "name": "address2", + "type": "string", + "form": "local", + "doc": "The second line of the mailing address belonging to an account." + }, + "allowedPptpVpnQuantity": { + "name": "allowedPptpVpnQuantity", + "type": "int", + "form": "local", + "doc": "The number of PPTP VPN users allowed on an account.", + "deprecated": true + }, + "alternatePhone": { + "name": "alternatePhone", + "type": "string", + "form": "local", + "doc": "A secondary phone number assigned to an account." + }, + "brandId": { + "name": "brandId", + "type": "int", + "form": "local", + "doc": "The Brand tied to an account." + }, + "city": { + "name": "city", + "type": "string", + "form": "local", + "doc": "The city of the mailing address belonging to an account." + }, + "claimedTaxExemptTxFlag": { + "name": "claimedTaxExemptTxFlag", + "type": "boolean", + "form": "local", + "doc": "Whether an account is exempt from taxes on their invoices." + }, + "companyName": { + "name": "companyName", + "type": "string", + "form": "local", + "doc": "The company name associated with an account." + }, + "country": { + "name": "country", + "type": "string", + "form": "local", + "doc": "A two-letter abbreviation of the country in the mailing address belonging to an account." + }, + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date an account was created." + }, + "deviceFingerprintId": { + "name": "deviceFingerprintId", + "type": "string", + "form": "local", + "doc": "Device Fingerprint Identifier - Used internally and can safely be ignored." + }, + "email": { + "name": "email", + "type": "string", + "form": "local", + "doc": "A general email address assigned to an account." + }, + "faxPhone": { + "name": "faxPhone", + "type": "string", + "form": "local", + "doc": "A fax phone number assigned to an account." + }, + "firstName": { + "name": "firstName", + "type": "string", + "form": "local", + "doc": "Each customer account is listed under a single individual. This is that individual's first name." + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "A customer account's internal identifier. Account numbers are typically preceded by the string \"SL\" in the customer portal. Every SoftLayer account has at least one portal user whose username follows the \"SL\" + account number naming scheme. " + }, + "isReseller": { + "name": "isReseller", + "type": "int", + "form": "local", + "doc": "A flag indicating if an account belongs to a reseller or not." + }, + "lastName": { + "name": "lastName", + "type": "string", + "form": "local", + "doc": "Each customer account is listed under a single individual. This is that individual's last name." + }, + "lateFeeProtectionFlag": { + "name": "lateFeeProtectionFlag", + "type": "boolean", + "form": "local", + "doc": "Whether an account has late fee protection." + }, + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "The date an account was last modified." + }, + "officePhone": { + "name": "officePhone", + "type": "string", + "form": "local", + "doc": "An office phone number assigned to an account." + }, + "postalCode": { + "name": "postalCode", + "type": "string", + "form": "local", + "doc": "The postal code of the mailing address belonging to an account." + }, + "resellerLevel": { + "name": "resellerLevel", + "type": "int", + "form": "local", + "doc": "The Reseller level of the account." + }, + "state": { + "name": "state", + "type": "string", + "form": "local", + "doc": "A two-letter abbreviation of the state in the mailing address belonging to an account. If an account does not reside in a province then this is typically blank." + }, + "statusDate": { + "name": "statusDate", + "type": "dateTime", + "form": "local", + "doc": "The date of an account's last status change." + }, + "abuseEmailCount": { + "name": "abuseEmailCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses." + }, + "accountContactCount": { + "name": "accountContactCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the account contacts on an account." + }, + "accountLicenseCount": { + "name": "accountLicenseCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the account software licenses owned by an account" + }, + "accountLinkCount": { + "name": "accountLinkCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "activeAccountLicenseCount": { + "name": "activeAccountLicenseCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the active account software licenses owned by an account" + }, + "activeAddressCount": { + "name": "activeAddressCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the active address(es) that belong to an account." + }, + "activeAgreementCount": { + "name": "activeAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all active agreements for an account" + }, + "activeBillingAgreementCount": { + "name": "activeBillingAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all billing agreements for an account" + }, + "activeColocationContainerCount": { + "name": "activeColocationContainerCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of deprecated." + }, + "activeFlexibleCreditEnrollmentCount": { + "name": "activeFlexibleCreditEnrollmentCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "activeNotificationSubscriberCount": { + "name": "activeNotificationSubscriberCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "activeQuoteCount": { + "name": "activeQuoteCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's non-expired quotes." + }, + "activeReservedCapacityAgreementCount": { + "name": "activeReservedCapacityAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of active reserved capacity agreements for an account" + }, + "activeVirtualLicenseCount": { + "name": "activeVirtualLicenseCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the virtual software licenses controlled by an account" + }, + "adcLoadBalancerCount": { + "name": "adcLoadBalancerCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated load balancers." + }, + "addressCount": { + "name": "addressCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all the address(es) that belong to an account." + }, + "allCommissionBillingItemCount": { + "name": "allCommissionBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the billing items that will be on an account's next invoice." + }, + "allRecurringTopLevelBillingItemCount": { + "name": "allRecurringTopLevelBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the billing items that will be on an account's next invoice." + }, + "allRecurringTopLevelBillingItemsUnfilteredCount": { + "name": "allRecurringTopLevelBillingItemsUnfilteredCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the billing items that will be on an account's next invoice. Does not consider associated items." + }, + "allSubnetBillingItemCount": { + "name": "allSubnetBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the billing items that will be on an account's next invoice." + }, + "allTopLevelBillingItemCount": { + "name": "allTopLevelBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all billing items of an account." + }, + "allTopLevelBillingItemsUnfilteredCount": { + "name": "allTopLevelBillingItemsUnfilteredCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the billing items that will be on an account's next invoice. Does not consider associated items." + }, + "applicationDeliveryControllerCount": { + "name": "applicationDeliveryControllerCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated application delivery controller records." + }, + "attributeCount": { + "name": "attributeCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the account attribute values for a SoftLayer customer account." + }, + "availablePublicNetworkVlanCount": { + "name": "availablePublicNetworkVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the public network VLANs assigned to an account." + }, + "bandwidthAllotmentCount": { + "name": "bandwidthAllotmentCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the bandwidth allotments for an account." + }, + "bandwidthAllotmentsOverAllocationCount": { + "name": "bandwidthAllotmentsOverAllocationCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the bandwidth allotments for an account currently over allocation." + }, + "bandwidthAllotmentsProjectedOverAllocationCount": { + "name": "bandwidthAllotmentsProjectedOverAllocationCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the bandwidth allotments for an account projected to go over allocation." + }, + "bareMetalInstanceCount": { + "name": "bareMetalInstanceCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated bare metal server objects." + }, + "billingAgreementCount": { + "name": "billingAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all billing agreements for an account" + }, + "blockDeviceTemplateGroupCount": { + "name": "blockDeviceTemplateGroupCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of private template group objects (parent and children) and the shared template group objects (parent only) for an account." + }, + "cartCount": { + "name": "cartCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's active carts." + }, + "catalystEnrollmentCount": { + "name": "catalystEnrollmentCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "closedTicketCount": { + "name": "closedTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all closed tickets associated with an account." + }, + "datacentersWithSubnetAllocationCount": { + "name": "datacentersWithSubnetAllocationCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of datacenters which contain subnets that the account has access to route." + }, + "dedicatedHostCount": { + "name": "dedicatedHostCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated virtual dedicated host objects." + }, + "displaySupportRepresentativeAssignmentCount": { + "name": "displaySupportRepresentativeAssignmentCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the SoftLayer employees that an account is assigned to." + }, + "domainCount": { + "name": "domainCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the DNS domains associated with an account." + }, + "domainsWithoutSecondaryDnsRecordCount": { + "name": "domainsWithoutSecondaryDnsRecordCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer." + }, + "evaultMasterUserCount": { + "name": "evaultMasterUserCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's master EVault user. This is only used when an account has EVault service." + }, + "evaultNetworkStorageCount": { + "name": "evaultNetworkStorageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated EVault storage volumes." + }, + "expiredSecurityCertificateCount": { + "name": "expiredSecurityCertificateCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of stored security certificates that are expired (ie. SSL)" + }, + "facilityLogCount": { + "name": "facilityLogCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter." + }, + "flexibleCreditEnrollmentCount": { + "name": "flexibleCreditEnrollmentCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all of the account's current and former Flexible Credit enrollments." + }, + "globalIpRecordCount": { + "name": "globalIpRecordCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "globalIpv4RecordCount": { + "name": "globalIpv4RecordCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "globalIpv6RecordCount": { + "name": "globalIpv6RecordCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "hardwareCount": { + "name": "hardwareCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated hardware objects." + }, + "hardwareOverBandwidthAllocationCount": { + "name": "hardwareOverBandwidthAllocationCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated hardware objects currently over bandwidth allocation." + }, + "hardwareProjectedOverBandwidthAllocationCount": { + "name": "hardwareProjectedOverBandwidthAllocationCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated hardware objects projected to go over bandwidth allocation." + }, + "hardwareWithCpanelCount": { + "name": "hardwareWithCpanelCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all hardware associated with an account that has the cPanel web hosting control panel installed." + }, + "hardwareWithHelmCount": { + "name": "hardwareWithHelmCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all hardware associated with an account that has the Helm web hosting control panel installed." + }, + "hardwareWithMcafeeAntivirusRedhatCount": { + "name": "hardwareWithMcafeeAntivirusRedhatCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components." + }, + "hardwareWithMcafeeAntivirusWindowCount": { + "name": "hardwareWithMcafeeAntivirusWindowCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all hardware associated with an account that has McAfee Secure AntiVirus for Windows software components." + }, + "hardwareWithMcafeeCount": { + "name": "hardwareWithMcafeeCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all hardware associated with an account that has McAfee Secure software components." + }, + "hardwareWithMcafeeIntrusionDetectionSystemCount": { + "name": "hardwareWithMcafeeIntrusionDetectionSystemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all hardware associated with an account that has McAfee Secure Intrusion Detection System software components." + }, + "hardwareWithPleskCount": { + "name": "hardwareWithPleskCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all hardware associated with an account that has the Plesk web hosting control panel installed." + }, + "hardwareWithQuantastorCount": { + "name": "hardwareWithQuantastorCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all hardware associated with an account that has the QuantaStor storage system installed." + }, + "hardwareWithUrchinCount": { + "name": "hardwareWithUrchinCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all hardware associated with an account that has the Urchin web traffic analytics package installed." + }, + "hardwareWithWindowCount": { + "name": "hardwareWithWindowCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all hardware associated with an account that is running a version of the Microsoft Windows operating system." + }, + "hourlyBareMetalInstanceCount": { + "name": "hourlyBareMetalInstanceCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated hourly bare metal server objects." + }, + "hourlyServiceBillingItemCount": { + "name": "hourlyServiceBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of hourly service billing items that will be on an account's next invoice." + }, + "hourlyVirtualGuestCount": { + "name": "hourlyVirtualGuestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated hourly virtual guest objects." + }, + "hubNetworkStorageCount": { + "name": "hubNetworkStorageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated Virtual Storage volumes." + }, + "internalNoteCount": { + "name": "internalNoteCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "invoiceCount": { + "name": "invoiceCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated billing invoices." + }, + "ipAddressCount": { + "name": "ipAddressCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "iscsiNetworkStorageCount": { + "name": "iscsiNetworkStorageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated iSCSI storage volumes." + }, + "lastFiveClosedAbuseTicketCount": { + "name": "lastFiveClosedAbuseTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the five most recently closed abuse tickets associated with an account." + }, + "lastFiveClosedAccountingTicketCount": { + "name": "lastFiveClosedAccountingTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the five most recently closed accounting tickets associated with an account." + }, + "lastFiveClosedOtherTicketCount": { + "name": "lastFiveClosedOtherTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account." + }, + "lastFiveClosedSalesTicketCount": { + "name": "lastFiveClosedSalesTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the five most recently closed sales tickets associated with an account." + }, + "lastFiveClosedSupportTicketCount": { + "name": "lastFiveClosedSupportTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the five most recently closed support tickets associated with an account." + }, + "lastFiveClosedTicketCount": { + "name": "lastFiveClosedTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the five most recently closed tickets associated with an account." + }, + "loadBalancerCount": { + "name": "loadBalancerCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated load balancers." + }, + "lockboxNetworkStorageCount": { + "name": "lockboxNetworkStorageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated Lockbox storage volumes." + }, + "manualPaymentsUnderReviewCount": { + "name": "manualPaymentsUnderReviewCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "mediaDataTransferRequestCount": { + "name": "mediaDataTransferRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's media transfer service requests." + }, + "monthlyBareMetalInstanceCount": { + "name": "monthlyBareMetalInstanceCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated monthly bare metal server objects." + }, + "monthlyVirtualGuestCount": { + "name": "monthlyVirtualGuestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated monthly virtual guest objects." + }, + "nasNetworkStorageCount": { + "name": "nasNetworkStorageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated NAS storage volumes." + }, + "networkGatewayCount": { + "name": "networkGatewayCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all network gateway devices on this account." + }, + "networkHardwareCount": { + "name": "networkHardwareCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated network hardware." + }, + "networkMessageDeliveryAccountCount": { + "name": "networkMessageDeliveryAccountCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "networkMonitorDownHardwareCount": { + "name": "networkMonitorDownHardwareCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of hardware which is currently experiencing a service failure." + }, + "networkMonitorDownVirtualGuestCount": { + "name": "networkMonitorDownVirtualGuestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of virtual guest which is currently experiencing a service failure." + }, + "networkMonitorRecoveringHardwareCount": { + "name": "networkMonitorRecoveringHardwareCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of hardware which is currently recovering from a service failure." + }, + "networkMonitorRecoveringVirtualGuestCount": { + "name": "networkMonitorRecoveringVirtualGuestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of virtual guest which is currently recovering from a service failure." + }, + "networkMonitorUpHardwareCount": { + "name": "networkMonitorUpHardwareCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of hardware which is currently online." + }, + "networkMonitorUpVirtualGuestCount": { + "name": "networkMonitorUpVirtualGuestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of virtual guest which is currently online." + }, + "networkStorageCount": { + "name": "networkStorageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes." + }, + "networkStorageGroupCount": { + "name": "networkStorageGroupCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's Network Storage groups." + }, + "networkTunnelContextCount": { + "name": "networkTunnelContextCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of iPSec network tunnels for an account." + }, + "networkVlanCount": { + "name": "networkVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all network VLANs assigned to an account." + }, + "nextInvoiceTopLevelBillingItemCount": { + "name": "nextInvoiceTopLevelBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the billing items that will be on an account's next invoice." + }, + "notificationSubscriberCount": { + "name": "notificationSubscriberCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "openAbuseTicketCount": { + "name": "openAbuseTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the open abuse tickets associated with an account." + }, + "openAccountingTicketCount": { + "name": "openAccountingTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the open accounting tickets associated with an account." + }, + "openBillingTicketCount": { + "name": "openBillingTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the open billing tickets associated with an account." + }, + "openCancellationRequestCount": { + "name": "openCancellationRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an open ticket requesting cancellation of this server, if one exists." + }, + "openOtherTicketCount": { + "name": "openOtherTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account." + }, + "openRecurringInvoiceCount": { + "name": "openRecurringInvoiceCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's recurring invoices." + }, + "openSalesTicketCount": { + "name": "openSalesTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the open sales tickets associated with an account." + }, + "openStackAccountLinkCount": { + "name": "openStackAccountLinkCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "openStackObjectStorageCount": { + "name": "openStackObjectStorageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated Openstack related Object Storage accounts." + }, + "openSupportTicketCount": { + "name": "openSupportTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the open support tickets associated with an account." + }, + "openTicketCount": { + "name": "openTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all open tickets associated with an account." + }, + "openTicketsWaitingOnCustomerCount": { + "name": "openTicketsWaitingOnCustomerCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all open tickets associated with an account last edited by an employee." + }, + "orderCount": { + "name": "orderCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated billing orders excluding upgrades." + }, + "orphanBillingItemCount": { + "name": "orphanBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the billing items that have no parent billing item. These are items that don't necessarily belong to a single server." + }, + "ownedBrandCount": { + "name": "ownedBrandCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "ownedHardwareGenericComponentModelCount": { + "name": "ownedHardwareGenericComponentModelCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "paymentProcessorCount": { + "name": "paymentProcessorCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "pendingEventCount": { + "name": "pendingEventCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "pendingInvoiceTopLevelItemCount": { + "name": "pendingInvoiceTopLevelItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a list of top-level invoice items that are on an account's currently pending invoice." + }, + "permissionGroupCount": { + "name": "permissionGroupCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's permission groups." + }, + "permissionRoleCount": { + "name": "permissionRoleCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's user roles." + }, + "placementGroupCount": { + "name": "placementGroupCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated virtual placement groups." + }, + "portableStorageVolumeCount": { + "name": "portableStorageVolumeCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "postProvisioningHookCount": { + "name": "postProvisioningHookCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of customer specified URIs that are downloaded onto a newly provisioned or reloaded server. If the URI is sent over https it will be executed directly on the server." + }, + "pptpVpnUserCount": { + "name": "pptpVpnUserCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated portal users with PPTP VPN access. (Deprecated)" + }, + "preOpenRecurringInvoiceCount": { + "name": "preOpenRecurringInvoiceCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's invoices in the PRE_OPEN status." + }, + "priceRestrictionCount": { + "name": "priceRestrictionCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the item price that an account is restricted to." + }, + "priorityOneTicketCount": { + "name": "priorityOneTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all priority one tickets associated with an account." + }, + "privateBlockDeviceTemplateGroupCount": { + "name": "privateBlockDeviceTemplateGroupCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of private and shared template group objects (parent only) for an account." + }, + "privateIpAddressCount": { + "name": "privateIpAddressCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "privateNetworkVlanCount": { + "name": "privateNetworkVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the private network VLANs assigned to an account." + }, + "privateSubnetCount": { + "name": "privateSubnetCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all private subnets associated with an account." + }, + "publicIpAddressCount": { + "name": "publicIpAddressCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "publicNetworkVlanCount": { + "name": "publicNetworkVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the public network VLANs assigned to an account." + }, + "publicSubnetCount": { + "name": "publicSubnetCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all public network subnets associated with an account." + }, + "quoteCount": { + "name": "quoteCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's quotes." + }, + "recentEventCount": { + "name": "recentEventCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "referredAccountCount": { + "name": "referredAccountCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of if this is a account is a referral partner, the accounts this referral partner has referred" + }, + "regulatedWorkloadCount": { + "name": "regulatedWorkloadCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "remoteManagementCommandRequestCount": { + "name": "remoteManagementCommandRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of remote management command requests for an account" + }, + "replicationEventCount": { + "name": "replicationEventCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the Replication events for all Network Storage volumes on an account." + }, + "reservedCapacityAgreementCount": { + "name": "reservedCapacityAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all reserved capacity agreements for an account" + }, + "reservedCapacityGroupCount": { + "name": "reservedCapacityGroupCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the reserved capacity groups owned by this account." + }, + "routerCount": { + "name": "routerCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all Routers that an accounts VLANs reside on" + }, + "rwhoisDataCount": { + "name": "rwhoisDataCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of dEPRECATED" + }, + "secondaryDomainCount": { + "name": "secondaryDomainCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the secondary DNS records for a SoftLayer customer account." + }, + "securityCertificateCount": { + "name": "securityCertificateCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of stored security certificates (ie. SSL)" + }, + "securityGroupCount": { + "name": "securityGroupCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the security groups belonging to this account." + }, + "securityScanRequestCount": { + "name": "securityScanRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's vulnerability scan requests." + }, + "serviceBillingItemCount": { + "name": "serviceBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the service billing items that will be on an account's next invoice. " + }, + "shipmentCount": { + "name": "shipmentCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of shipments that belong to the customer's account." + }, + "sshKeyCount": { + "name": "sshKeyCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server." + }, + "sslVpnUserCount": { + "name": "sslVpnUserCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated portal users with SSL VPN access." + }, + "standardPoolVirtualGuestCount": { + "name": "standardPoolVirtualGuestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's virtual guest objects that are hosted on a user provisioned hypervisor." + }, + "subnetCount": { + "name": "subnetCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all network subnets associated with an account." + }, + "subnetRegistrationCount": { + "name": "subnetRegistrationCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "subnetRegistrationDetailCount": { + "name": "subnetRegistrationDetailCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "supportRepresentativeCount": { + "name": "supportRepresentativeCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the SoftLayer employees that an account is assigned to." + }, + "supportSubscriptionCount": { + "name": "supportSubscriptionCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the active support subscriptions for this account." + }, + "tagCount": { + "name": "tagCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "ticketCount": { + "name": "ticketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated tickets." + }, + "ticketsClosedInTheLastThreeDaysCount": { + "name": "ticketsClosedInTheLastThreeDaysCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account." + }, + "ticketsClosedTodayCount": { + "name": "ticketsClosedTodayCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of tickets closed today associated with an account." + }, + "upgradeRequestCount": { + "name": "upgradeRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated upgrade requests." + }, + "userCount": { + "name": "userCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's portal users." + }, + "validSecurityCertificateCount": { + "name": "validSecurityCertificateCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of stored security certificates that are not expired (ie. SSL)" + }, + "virtualDedicatedRackCount": { + "name": "virtualDedicatedRackCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the bandwidth pooling for this account." + }, + "virtualDiskImageCount": { + "name": "virtualDiskImageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated virtual server virtual disk images." + }, + "virtualGuestCount": { + "name": "virtualGuestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated virtual guest objects." + }, + "virtualGuestsOverBandwidthAllocationCount": { + "name": "virtualGuestsOverBandwidthAllocationCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated virtual guest objects currently over bandwidth allocation." + }, + "virtualGuestsProjectedOverBandwidthAllocationCount": { + "name": "virtualGuestsProjectedOverBandwidthAllocationCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated virtual guest objects currently over bandwidth allocation." + }, + "virtualGuestsWithCpanelCount": { + "name": "virtualGuestsWithCpanelCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all virtual guests associated with an account that has the cPanel web hosting control panel installed." + }, + "virtualGuestsWithMcafeeAntivirusRedhatCount": { + "name": "virtualGuestsWithMcafeeAntivirusRedhatCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components." + }, + "virtualGuestsWithMcafeeAntivirusWindowCount": { + "name": "virtualGuestsWithMcafeeAntivirusWindowCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components." + }, + "virtualGuestsWithMcafeeCount": { + "name": "virtualGuestsWithMcafeeCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all virtual guests associated with an account that have McAfee Secure software components." + }, + "virtualGuestsWithMcafeeIntrusionDetectionSystemCount": { + "name": "virtualGuestsWithMcafeeIntrusionDetectionSystemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components." + }, + "virtualGuestsWithPleskCount": { + "name": "virtualGuestsWithPleskCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all virtual guests associated with an account that has the Plesk web hosting control panel installed." + }, + "virtualGuestsWithQuantastorCount": { + "name": "virtualGuestsWithQuantastorCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all virtual guests associated with an account that have the QuantaStor storage system installed." + }, + "virtualGuestsWithUrchinCount": { + "name": "virtualGuestsWithUrchinCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all virtual guests associated with an account that has the Urchin web traffic analytics package installed." + }, + "virtualStorageArchiveRepositoryCount": { + "name": "virtualStorageArchiveRepositoryCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated virtual server archived storage repositories." + }, + "virtualStoragePublicRepositoryCount": { + "name": "virtualStoragePublicRepositoryCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated virtual server public storage repositories." + }, + "vpcVirtualGuestCount": { + "name": "vpcVirtualGuestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated VPC configured virtual guest objects." + } + } + }, + "SoftLayer_Account_AbuseEmail": { + "name": "SoftLayer_Account_AbuseEmail", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "An unfortunate facet of the hosting business is the necessity of with legal and network abuse inquiries. As these types of inquiries frequently contain sensitive information SoftLayer keeps a separate account contact email address for direct contact about legal and abuse matters, modeled by the SoftLayer_Account_AbuseEmail data type. SoftLayer will typically email an account's abuse email addresses in these types of cases, and an email is automatically sent to an account's abuse email addresses when a legal or abuse ticket is created or updated. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account associated with an abuse email address." + }, + "email": { + "name": "email", + "type": "string", + "form": "local", + "doc": "A valid email address." + } + }, + "methods": {} + }, + "SoftLayer_Account_Address": { + "name": "SoftLayer_Account_Address", + "base": "SoftLayer_Entity", + "serviceDoc": "SoftLayer's address service allows you to access and manage addresses associated with your account. ", + "methods": { + "createObject": { + "name": "createObject", + "type": "SoftLayer_Account_Address", + "doc": "Create a new address record. The ''typeId'', ''accountId'', ''description'', ''address1'', ''city'', ''state'', ''country'', and ''postalCode'' properties in the templateObject parameter are required properties and may not be null or empty. Users will be restricted to creating addresses for their account. ", + "docOverview": "Create a new address record.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "templateObject", + "type": "SoftLayer_Account_Address", + "doc": "The SoftLayer_Account_Address object that you wish to create." + } + ] + }, + "editObject": { + "name": "editObject", + "type": "boolean", + "doc": "Edit the properties of an address record by passing in a modified instance of a SoftLayer_Account_Address object. Users will be restricted to modifying addresses for their account. ", + "docOverview": "Edit an address record.", + "parameters": [ + { + "name": "templateObject", + "type": "SoftLayer_Account_Address", + "doc": "A skeleton SoftLayer_Account_Address object with only the properties defined that you wish to change. Unchanged properties are left alone." + } + ] + }, + "getAllDataCenters": { + "name": "getAllDataCenters", + "type": "SoftLayer_Account_Address", + "typeArray": true, + "doc": "Retrieve a list of SoftLayer datacenter addresses.", + "docOverview": "Retrieve a list of SoftLayer datacenter addresses.", + "static": true, + "maskable": true + }, + "getNetworkAddress": { + "name": "getNetworkAddress", + "type": "SoftLayer_Account_Address", + "typeArray": true, + "doc": "Retrieve a list of SoftLayer datacenter addresses.", + "docOverview": "Retrieve a list of SoftLayer datacenter addresses.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "name", + "type": "string", + "doc": "Location Name." + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account_Address", + "docOverview": "Retrieve a SoftLayer_Account_Address record.", + "filterable": true, + "maskable": true + }, + "getAccount": { + "doc": "The account to which this address belongs.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCreateUser": { + "doc": "The customer user who created this address.", + "docOverview": "", + "name": "getCreateUser", + "type": "SoftLayer_User_Customer", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "The location of this address.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getModifyEmployee": { + "doc": "The employee who last modified this address.", + "docOverview": "", + "name": "getModifyEmployee", + "type": "SoftLayer_User_Employee", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getModifyUser": { + "doc": "The customer user who last modified this address.", + "docOverview": "", + "name": "getModifyUser", + "type": "SoftLayer_User_Customer", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getType": { + "doc": "An account address' type.", + "docOverview": "", + "name": "getType", + "type": "SoftLayer_Account_Address_Type", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + } + }, + "typeDoc": "The SoftLayer_Account_Address data type contains information on an address associated with a SoftLayer account. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account to which this address belongs." + }, + "createUser": { + "name": "createUser", + "type": "SoftLayer_User_Customer", + "form": "relational", + "doc": "The customer user who created this address." + }, + "location": { + "name": "location", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "The location of this address." + }, + "modifyEmployee": { + "name": "modifyEmployee", + "type": "SoftLayer_User_Employee", + "form": "relational", + "doc": "The employee who last modified this address." + }, + "modifyUser": { + "name": "modifyUser", + "type": "SoftLayer_User_Customer", + "form": "relational", + "doc": "The customer user who last modified this address." + }, + "type": { + "name": "type", + "type": "SoftLayer_Account_Address_Type", + "form": "relational", + "doc": "An account address' type." + }, + "accountId": { + "name": "accountId", + "type": "int", + "form": "local" + }, + "address1": { + "name": "address1", + "type": "string", + "form": "local", + "doc": "Line 1 of the address (normally the street address)." + }, + "address2": { + "name": "address2", + "type": "string", + "form": "local", + "doc": "Line 2 of the address." + }, + "city": { + "name": "city", + "type": "string", + "form": "local", + "doc": "The city of the address." + }, + "contactName": { + "name": "contactName", + "type": "string", + "form": "local", + "doc": "The contact name (person, office) of the address." + }, + "country": { + "name": "country", + "type": "string", + "form": "local", + "doc": "The country of the address." + }, + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "The description of the address." + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique id of the address." + }, + "isActive": { + "name": "isActive", + "type": "int", + "form": "local", + "doc": "Flag to show whether the address is active." + }, + "locationId": { + "name": "locationId", + "type": "int", + "form": "local", + "doc": "The location id of the address." + }, + "postalCode": { + "name": "postalCode", + "type": "string", + "form": "local", + "doc": "The postal (zip) code of the address." + }, + "state": { + "name": "state", + "type": "string", + "form": "local", + "doc": "The state of the address." + } + } + }, + "SoftLayer_Account_Address_Type": { + "name": "SoftLayer_Account_Address_Type", + "base": "SoftLayer_Entity", + "methods": { + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account_Address_Type", + "docOverview": "Retrieve a SoftLayer_Account_Address_Type record.", + "filterable": true, + "maskable": true + } + }, + "properties": { + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "DEPRECATED", + "deprecated": true + }, + "id": { + "name": "id", + "type": "int", + "form": "local" + }, + "keyName": { + "name": "keyName", + "type": "string", + "form": "local" + }, + "name": { + "name": "name", + "type": "string", + "form": "local" + } + } + }, + "SoftLayer_Account_Affiliation": { + "name": "SoftLayer_Account_Affiliation", + "base": "SoftLayer_Entity", + "methods": { + "createObject": { + "name": "createObject", + "type": "SoftLayer_Account_Affiliation", + "doc": "Create a new affiliation to associate with an existing account. ", + "docOverview": "Create a new affiliation.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "templateObject", + "type": "SoftLayer_Account_Affiliation", + "doc": "The SoftLayer_Account_Affiliation object that you wish to create." + } + ] + }, + "deleteObject": { + "name": "deleteObject", + "type": "boolean", + "doc": "deleteObject permanently removes an account affiliation ", + "docOverview": "Delete an account affiliation" + }, + "editObject": { + "name": "editObject", + "type": "boolean", + "doc": "Edit an affiliation that is associated to an existing account. ", + "docOverview": "Update an account affiliation information.", + "parameters": [ + { + "name": "templateObject", + "type": "SoftLayer_Account_Affiliation", + "doc": "A skeleton SoftLayer_Account_Affiliation object with only the properties defined that you wish to change. Unchanged properties are left alone." + } + ] + }, + "getAccountAffiliationsByAffiliateId": { + "name": "getAccountAffiliationsByAffiliateId", + "type": "SoftLayer_Account_Affiliation", + "typeArray": true, + "doc": "Get account affiliation information associated with affiliate id. ", + "docOverview": "Get account affiliation information associated with affiliate id.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "affiliateId", + "type": "string", + "doc": "Affiliate Id" + } + ] + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account_Affiliation", + "docOverview": "Retrieve a SoftLayer_Account_Affiliation record.", + "filterable": true, + "maskable": true + }, + "getAccount": { + "doc": "The account that an affiliation belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + } + }, + "typeDoc": "This service allows for a unique identifier to be associated to an existing customer account. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that an affiliation belongs to." + }, + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "A customer account's internal identifier. " + }, + "affiliateId": { + "name": "affiliateId", + "type": "string", + "form": "local", + "doc": "An affiliate identifier associated with the customer account. " + }, + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date an account affiliation was created. " + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "A customer affiliation internal identifier. " + }, + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "The date an account affiliation was last modified. " + } + } + }, + "SoftLayer_Account_Agreement": { + "name": "SoftLayer_Account_Agreement", + "base": "SoftLayer_Entity", + "methods": { + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account_Agreement", + "docOverview": "Retrieve a SoftLayer_Account_Agreement record.", + "filterable": true, + "maskable": true + }, + "getAccount": { + "doc": "", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAgreementType": { + "doc": "The type of agreement.", + "docOverview": "", + "name": "getAgreementType", + "type": "SoftLayer_Account_Agreement_Type", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAttachedBillingAgreementFiles": { + "doc": "The files attached to an agreement.", + "docOverview": "", + "name": "getAttachedBillingAgreementFiles", + "type": "SoftLayer_Account_MasterServiceAgreement", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBillingItems": { + "doc": "The billing items associated with an agreement.", + "docOverview": "", + "name": "getBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getStatus": { + "doc": "The status of the agreement.", + "docOverview": "", + "name": "getStatus", + "type": "SoftLayer_Account_Agreement_Status", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getTopLevelBillingItems": { + "doc": "The top level billing item associated with an agreement.", + "docOverview": "", + "name": "getTopLevelBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational" + }, + "agreementType": { + "name": "agreementType", + "type": "SoftLayer_Account_Agreement_Type", + "form": "relational", + "doc": "The type of agreement." + }, + "attachedBillingAgreementFiles": { + "name": "attachedBillingAgreementFiles", + "type": "SoftLayer_Account_MasterServiceAgreement", + "form": "relational", + "typeArray": true, + "doc": "The files attached to an agreement." + }, + "billingItems": { + "name": "billingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The billing items associated with an agreement." + }, + "status": { + "name": "status", + "type": "SoftLayer_Account_Agreement_Status", + "form": "relational", + "doc": "The status of the agreement." + }, + "topLevelBillingItems": { + "name": "topLevelBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "The top level billing item associated with an agreement." + }, + "agreementTypeId": { + "name": "agreementTypeId", + "type": "int", + "form": "local", + "doc": "The type of agreement identifier." + }, + "autoRenew": { + "name": "autoRenew", + "type": "int", + "form": "local" + }, + "cancellationFee": { + "name": "cancellationFee", + "type": "int", + "form": "local" + }, + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date an agreement was created." + }, + "durationMonths": { + "name": "durationMonths", + "type": "int", + "form": "local", + "doc": "The duration in months of an agreement." + }, + "endDate": { + "name": "endDate", + "type": "dateTime", + "form": "local", + "doc": "The end date of an agreement." + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "An agreement's internal identifier." + }, + "startDate": { + "name": "startDate", + "type": "dateTime", + "form": "local", + "doc": "The effective start date of an agreement." + }, + "statusId": { + "name": "statusId", + "type": "int", + "form": "local", + "doc": "The status identifier for an agreement." + }, + "title": { + "name": "title", + "type": "string", + "form": "local", + "doc": "The title of an agreement." + }, + "attachedBillingAgreementFileCount": { + "name": "attachedBillingAgreementFileCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the files attached to an agreement." + }, + "billingItemCount": { + "name": "billingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the billing items associated with an agreement." + }, + "topLevelBillingItemCount": { + "name": "topLevelBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the top level billing item associated with an agreement." + } + } + }, + "SoftLayer_Account_Agreement_Status": { + "name": "SoftLayer_Account_Agreement_Status", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name of the agreement status." + } + }, + "methods": {} + }, + "SoftLayer_Account_Agreement_Type": { + "name": "SoftLayer_Account_Agreement_Type", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name of the agreement type." + } + }, + "methods": {} + }, + "SoftLayer_Account_Attachment_Employee": { + "name": "SoftLayer_Account_Attachment_Employee", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "A SoftLayer_Account_Attachment_Employee models an assignment of a single [[SoftLayer_User_Employee|employee]] with a single [[SoftLayer_Account|account]] ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "A [[SoftLayer_Account|account]] that is assigned to a [[SoftLayer_User_Employee|employee]]." + }, + "employee": { + "name": "employee", + "type": "SoftLayer_User_Employee", + "form": "relational", + "doc": "A [[SoftLayer_User_Employee|employee]] that is assigned to a [[SoftLayer_Account|account]]." + }, + "employeeRole": { + "name": "employeeRole", + "type": "SoftLayer_Account_Attachment_Employee_Role", + "form": "relational", + "doc": "A [[SoftLayer_User_Employee|employee]] that is assigned to a [[SoftLayer_Account|account]]." + }, + "roleId": { + "name": "roleId", + "type": "int", + "form": "local", + "doc": "Role identifier.", + "deprecated": true + } + }, + "methods": {} + }, + "SoftLayer_Account_Attachment_Employee_Role": { + "name": "SoftLayer_Account_Attachment_Employee_Role", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "keyname": { + "name": "keyname", + "type": "string", + "form": "local" + }, + "name": { + "name": "name", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Account_Attribute": { + "name": "SoftLayer_Account_Attribute", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "Many SoftLayer customer accounts have individual attributes assigned to them that describe features or special features for that account, such as special pricing, account statuses, and ordering instructions. The SoftLayer_Account_Attribute data type contains information relating to a single SoftLayer_Account attribute. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The SoftLayer customer account that has an attribute." + }, + "accountAttributeType": { + "name": "accountAttributeType", + "type": "SoftLayer_Account_Attribute_Type", + "form": "relational", + "doc": "The type of attribute assigned to a SoftLayer customer account." + }, + "accountAttributeTypeId": { + "name": "accountAttributeTypeId", + "type": "int", + "form": "local", + "doc": "The internal identifier of the type of attribute that a SoftLayer customer account attribute belongs to. " + }, + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "The internal identifier of the SoftLayer customer account that is assigned an account attribute. " + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "A SoftLayer customer account attribute's internal identifier. " + }, + "value": { + "name": "value", + "type": "string", + "form": "local", + "doc": "A SoftLayer account attribute's value. " + } + }, + "methods": {} + }, + "SoftLayer_Account_Attribute_Type": { + "name": "SoftLayer_Account_Attribute_Type", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "SoftLayer_Account_Attribute_Type models the type of attribute that can be assigned to a SoftLayer customer account. ", + "properties": { + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "A brief description of a SoftLayer account attribute type. " + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "A SoftLayer account attribute type's internal identifier. " + }, + "keyName": { + "name": "keyName", + "type": "string", + "form": "local", + "doc": "A SoftLayer account attribute type's key name. This is typically a shorter version of an attribute type's name. " + }, + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "A SoftLayer account attribute type's name. " + } + }, + "methods": {} + }, + "SoftLayer_Account_Authentication_Attribute": { + "name": "SoftLayer_Account_Authentication_Attribute", + "base": "SoftLayer_Entity", + "methods": { + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account_Authentication_Attribute", + "docOverview": "Retrieve a SoftLayer_Account_Authentication_Attribute record.", + "filterable": true, + "maskable": true + }, + "getAccount": { + "doc": "The SoftLayer customer account.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAuthenticationRecord": { + "doc": "The SoftLayer account authentication that has an attribute.", + "docOverview": "", + "name": "getAuthenticationRecord", + "type": "SoftLayer_Account_Authentication_Saml", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getType": { + "doc": "The type of attribute assigned to a SoftLayer account authentication.", + "docOverview": "", + "name": "getType", + "type": "SoftLayer_Account_Authentication_Attribute_Type", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + } + }, + "typeDoc": "Account authentication has many different settings that can be set. This class allows the customer or employee to set these settings. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The SoftLayer customer account." + }, + "authenticationRecord": { + "name": "authenticationRecord", + "type": "SoftLayer_Account_Authentication_Saml", + "form": "relational", + "doc": "The SoftLayer account authentication that has an attribute." + }, + "type": { + "name": "type", + "type": "SoftLayer_Account_Authentication_Attribute_Type", + "form": "relational", + "doc": "The type of attribute assigned to a SoftLayer account authentication." + }, + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "The internal identifier of the SoftLayer customer account that is assigned an account authentication attribute. " + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "A SoftLayer account authentication attribute's internal identifier. " + }, + "typeId": { + "name": "typeId", + "type": "int", + "form": "local", + "doc": "The internal identifier of the type of attribute that a SoftLayer account authentication attribute belongs to. " + }, + "value": { + "name": "value", + "type": "string", + "form": "local", + "doc": "A SoftLayer account authentication attribute's value. " + } + } + }, + "SoftLayer_Account_Authentication_Attribute_Type": { + "name": "SoftLayer_Account_Authentication_Attribute_Type", + "base": "SoftLayer_Entity", + "methods": { + "getAllObjects": { + "name": "getAllObjects", + "type": "SoftLayer_Account_Attribute_Type", + "typeArray": true, + "static": true, + "limitable": true, + "filterable": true, + "maskable": true + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account_Authentication_Attribute_Type", + "docOverview": "Retrieve a SoftLayer_Account_Authentication_Attribute_Type record.", + "filterable": true, + "maskable": true + } + }, + "typeDoc": "SoftLayer_Account_Authentication_Attribute_Type models the type of attribute that can be assigned to a SoftLayer customer account authentication. ", + "properties": { + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "A brief description of a SoftLayer account authentication attribute type. " + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "A SoftLayer account authentication attribute type's internal identifier. " + }, + "keyName": { + "name": "keyName", + "type": "string", + "form": "local", + "doc": "A SoftLayer account authentication attribute type's key name. This is typically a shorter version of an attribute type's name. " + }, + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "A SoftLayer account authentication attribute type's name. " + }, + "valueExample": { + "name": "valueExample", + "type": "string", + "form": "local", + "doc": "An example of what you can put in as your value. " + } + } + }, + "SoftLayer_Account_Authentication_OpenIdConnect_Option": { + "name": "SoftLayer_Account_Authentication_OpenIdConnect_Option", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "key": { + "name": "key", + "type": "string", + "form": "local" + }, + "value": { + "name": "value", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Account_Authentication_OpenIdConnect_RegistrationInformation": { + "name": "SoftLayer_Account_Authentication_OpenIdConnect_RegistrationInformation", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "existingBlueIdFlag": { + "name": "existingBlueIdFlag", + "type": "boolean", + "form": "local" + }, + "federatedEmailDomainFlag": { + "name": "federatedEmailDomainFlag", + "type": "boolean", + "form": "local" + }, + "user": { + "name": "user", + "type": "SoftLayer_User_Customer", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Account_Authentication_Saml": { + "name": "SoftLayer_Account_Authentication_Saml", + "base": "SoftLayer_Entity", + "methods": { + "createObject": { + "name": "createObject", + "type": "SoftLayer_Account_Authentication_Saml", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "templateObject", + "type": "SoftLayer_Account_Authentication_Saml", + "doc": "The SoftLayer_Account_Authentication_Saml object that you wish to create." + } + ] + }, + "deleteObject": { + "name": "deleteObject", + "type": "boolean" + }, + "editObject": { + "name": "editObject", + "type": "boolean", + "doc": "Edit the object by passing in a modified instance of the object ", + "docOverview": "Edit the object by passing in a modified instance of the object.", + "parameters": [ + { + "name": "templateObject", + "type": "SoftLayer_Account_Authentication_Saml", + "doc": "A skeleton SoftLayer_Account_Authentication_Saml object with only the properties defined that you wish to change. Unchanged properties are left alone." + } + ] + }, + "getMetadata": { + "name": "getMetadata", + "type": "string", + "doc": "This method will return the service provider metadata in XML format. ", + "docOverview": "Get the service provider meta data." + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account_Authentication_Saml", + "docOverview": "Retrieve a SoftLayer_Account_Authentication_Saml record.", + "filterable": true, + "maskable": true + }, + "getAccount": { + "doc": "The account associated with this saml configuration.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAttributes": { + "doc": "The saml attribute values for a SoftLayer customer account.", + "docOverview": "", + "name": "getAttributes", + "type": "SoftLayer_Account_Authentication_Attribute", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account associated with this saml configuration." + }, + "attributes": { + "name": "attributes", + "type": "SoftLayer_Account_Authentication_Attribute", + "form": "relational", + "typeArray": true, + "doc": "The saml attribute values for a SoftLayer customer account." + }, + "accountId": { + "name": "accountId", + "type": "string", + "form": "local", + "doc": "The saml account id." + }, + "certificate": { + "name": "certificate", + "type": "string", + "form": "local", + "doc": "The identity provider x509 certificate." + }, + "certificateFingerprint": { + "name": "certificateFingerprint", + "type": "string", + "form": "local", + "doc": "The identity provider x509 certificate fingerprint." + }, + "entityId": { + "name": "entityId", + "type": "string", + "form": "local", + "doc": "The identity provider entity ID." + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The saml internal identifying number." + }, + "serviceProviderCertificate": { + "name": "serviceProviderCertificate", + "type": "string", + "form": "local", + "doc": "The service provider x509 certificate." + }, + "serviceProviderEntityId": { + "name": "serviceProviderEntityId", + "type": "string", + "form": "local", + "doc": "The service provider entity IDs." + }, + "serviceProviderPublicKey": { + "name": "serviceProviderPublicKey", + "type": "string", + "form": "local", + "doc": "The service provider public key." + }, + "serviceProviderSingleLogoutEncoding": { + "name": "serviceProviderSingleLogoutEncoding", + "type": "string", + "form": "local", + "doc": "The service provider signle logout encoding." + }, + "serviceProviderSingleLogoutUrl": { + "name": "serviceProviderSingleLogoutUrl", + "type": "string", + "form": "local", + "doc": "The service provider signle logout address." + }, + "serviceProviderSingleSignOnEncoding": { + "name": "serviceProviderSingleSignOnEncoding", + "type": "string", + "form": "local", + "doc": "The service provider signle sign on encoding." + }, + "serviceProviderSingleSignOnUrl": { + "name": "serviceProviderSingleSignOnUrl", + "type": "string", + "form": "local", + "doc": "The service provider signle sign on address." + }, + "singleLogoutEncoding": { + "name": "singleLogoutEncoding", + "type": "string", + "form": "local", + "doc": "The identity provider single logout encoding." + }, + "singleLogoutUrl": { + "name": "singleLogoutUrl", + "type": "string", + "form": "local", + "doc": "The identity provider sigle logout address." + }, + "singleSignOnEncoding": { + "name": "singleSignOnEncoding", + "type": "string", + "form": "local", + "doc": "The identity provider single sign on encoding." + }, + "singleSignOnUrl": { + "name": "singleSignOnUrl", + "type": "string", + "form": "local", + "doc": "The identity provider signle sign on address." + }, + "attributeCount": { + "name": "attributeCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the saml attribute values for a SoftLayer customer account." + } + } + }, + "SoftLayer_Account_Brand_Migration_Request": { + "name": "SoftLayer_Account_Brand_Migration_Request", + "base": "SoftLayer_Entity", + "serviceDoc": "Retrieve a request to migrate an account to the owned brand. Note that the brand must be configured to allow migrations. The three statuses are \"PENDING\", \"COMPLETE\", and \"ERROR\". If the request is \"COMPLETE\", then the account successfully migrated. If the request is \"PENDING\", it will be migrated at the given `migrationDate.` The \"ERROR\" status means an error occurred, and more information can be found in the `statusMessage`. ", + "methods": { + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account_Brand_Migration_Request", + "docOverview": "Retrieve a SoftLayer_Account_Brand_Migration_Request record.", + "filterable": true, + "maskable": true + }, + "getAccount": { + "doc": "", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getDestinationBrand": { + "doc": "", + "docOverview": "", + "name": "getDestinationBrand", + "type": "SoftLayer_Brand", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSourceBrand": { + "doc": "", + "docOverview": "", + "name": "getSourceBrand", + "type": "SoftLayer_Brand", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUser": { + "doc": "", + "docOverview": "", + "name": "getUser", + "type": "SoftLayer_User_Customer", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + } + }, + "typeDoc": "Represents a request to migrate an account to the owned brand. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational" + }, + "destinationBrand": { + "name": "destinationBrand", + "type": "SoftLayer_Brand", + "form": "relational" + }, + "sourceBrand": { + "name": "sourceBrand", + "type": "SoftLayer_Brand", + "form": "relational" + }, + "user": { + "name": "user", + "type": "SoftLayer_User_Customer", + "form": "relational" + }, + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "ID of the [[SoftLayer_Account]]." + }, + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "Timestamp of when the request was created." + }, + "destinationBrandId": { + "name": "destinationBrandId", + "type": "int", + "form": "local", + "doc": "ID of the target [[SoftLayer_Brand]]." + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "ID of the request." + }, + "migrationDate": { + "name": "migrationDate", + "type": "dateTime", + "form": "local", + "doc": "Timestamp of when the migration will happen, or happened in the past." + }, + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "Timestamp of when the request was last modified." + }, + "sourceBrandId": { + "name": "sourceBrandId", + "type": "int", + "form": "local", + "doc": "ID of the source [[SoftLayer_Brand]]." + }, + "status": { + "name": "status", + "type": "string", + "form": "local", + "doc": "Status of the request." + }, + "statusMessage": { + "name": "statusMessage", + "type": "string", + "form": "local", + "doc": "If present, a message giving more details of the current status." + } + } + }, + "SoftLayer_Account_Business_Partner": { + "name": "SoftLayer_Account_Business_Partner", + "base": "SoftLayer_Entity", + "methods": { + "getObject": { + "name": "getObject", + "type": "SoftLayer_Account_Business_Partner", + "docOverview": "Retrieve a SoftLayer_Account_Business_Partner record.", + "filterable": true, + "maskable": true + }, + "getAccount": { + "doc": "Account associated with the business partner data", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChannel": { + "doc": "Channel indicator used to categorize business partner revenue.", + "docOverview": "", + "name": "getChannel", + "type": "SoftLayer_Business_Partner_Channel", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSegment": { + "doc": "Segment indicator used to categorize business partner revenue.", + "docOverview": "", + "name": "getSegment", + "type": "SoftLayer_Business_Partner_Segment", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + } + }, + "typeDoc": "Contains business partner details associated with an account. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "Account associated with the business partner data" + }, + "channel": { + "name": "channel", + "type": "SoftLayer_Business_Partner_Channel", + "form": "relational", + "doc": "Channel indicator used to categorize business partner revenue." + }, + "segment": { + "name": "segment", + "type": "SoftLayer_Business_Partner_Segment", + "form": "relational", + "doc": "Segment indicator used to categorize business partner revenue." + }, + "channelId": { + "name": "channelId", + "type": "int", + "form": "local", + "doc": "Account business partner channel identifier " + }, + "countryEnterpriseCode": { + "name": "countryEnterpriseCode", + "type": "string", + "form": "local", + "doc": "Account business partner country enterprise code " + }, + "resellerLevel": { + "name": "resellerLevel", + "type": "int", + "form": "local", + "doc": "Reseller level of an account business partner " + }, + "segmentId": { + "name": "segmentId", + "type": "int", + "form": "local", + "doc": "Account business partner segment identifier " + } + } + }, + "SoftLayer_Account_Classification_Group_Type": { + "name": "SoftLayer_Account_Classification_Group_Type", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "keyName": { + "name": "keyName", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Account_Contact": { + "name": "SoftLayer_Account_Contact", + "base": "SoftLayer_Entity", + "methods": { + "createComplianceReportRequestorContact": { + "name": "createComplianceReportRequestorContact", + "type": "SoftLayer_Account_Contact", + "doc": "<
detailTypeIdThe [[SoftLayer_Account_Regional_Registry_Detail_Type|type id]] of this detail object- Required
- Type - integer
regionalInternetRegistryHandleIdThe id of the [[SoftLayer_Account_Rwhois_Handle|RWhois handle]] object. This is only to be used for detailed registrations, where a subnet is registered to an organization. The associated handle will be required to be a valid organization object id at the relevant registry. In this case, the detail object will only be valid for the registry the organization belongs to.- Optional
- Type - integer
registrationDetailIdThe numeric ID of the [[SoftLayer_Account_Regional_Registry_Detail|detail object]] this property belongs to- Required
- Type - integer
propertyTypeIdThe numeric ID of the associated [[SoftLayer_Account_Regional_Registry_Detail_Property_Type]] object- Required
- Type - integer
sequencePositionWhen more than one property of the same type exists on a detail object, this value determines the position in that collection. This can be thought of more as a sort order.- Required
- Type - integer
valueThe actual value of the property.- Required
- Type - string
- NETWORK - The detail object represents the information for a [[SoftLayer_Network_Subnet|subnet]]
- NETWORK6 - The detail object represents the information for an [[SoftLayer_Network_Subnet_Version6|IPv6 subnet]]
- PERSON - The detail object represents the information for a customer with the RIR
detailTypeIdThe [[SoftLayer_Account_Regional_Registry_Detail_Type|type id]] of this detail object- Required
- Type - integer
regionalInternetRegistryHandleIdThe id of the [[SoftLayer_Account_Rwhois_Handle|RWhois handle]] object. This is only to be used for detailed registrations, where a subnet is registered to an organization. The associated handle will be required to be a valid organization object id at the relevant registry. In this case, the detail object will only be valid for the registry the organization belongs to.- Optional
- Type - integer
- ALL