From 9006334412ebff2f86c267ef8d6a75f51fc12951 Mon Sep 17 00:00:00 2001 From: Christopher Gallo Date: Wed, 30 Oct 2024 08:56:42 -0500 Subject: [PATCH] openAPI proof of concept --- .secrets.baseline | 2 +- bin/generateOpenAPI.py | 219 + openapi/openapi.json | 1231 + openapi/sl_openapi.json | 147303 +++++++++++++++++++ openapi/sldn_metadata.json | 262865 ++++++++++++++++++++++++++++++++++ 5 files changed, 411619 insertions(+), 1 deletion(-) create mode 100644 bin/generateOpenAPI.py create mode 100644 openapi/openapi.json create mode 100644 openapi/sl_openapi.json create mode 100644 openapi/sldn_metadata.json diff --git a/.secrets.baseline b/.secrets.baseline index 180dc5afba..71ae7eb875 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -1,6 +1,6 @@ { "exclude": { - "files": "static/*|content/reference/*|data/sldn_metadata\\.json|^.secrets.baseline$", + "files": "static/*|content/reference/*|data/sldn_metadata\\.json|^.secrets.baseline$|openapi/*", "lines": null }, "generated_at": "2024-08-16T19:42:32Z", diff --git a/bin/generateOpenAPI.py b/bin/generateOpenAPI.py new file mode 100644 index 0000000000..885771b5bb --- /dev/null +++ b/bin/generateOpenAPI.py @@ -0,0 +1,219 @@ +#!python + +import click +# from prettytable import PrettyTable +import json +import requests +import os +import shutil +from string import Template +import re + + +METAURL = 'https://api.softlayer.com/metadata/v3.1' + + +class OpenAPIGen(): + + def __init__(self, outdir: str) -> None: + self.outdir = outdir + if not os.path.isdir(self.outdir): + print(f"Creating directory {self.outdir}") + os.mkdir(self.outdir) + self.metajson = None + self.metapath = f'{self.outdir}/sldn_metadata.json' + self.openapi = { + "openapi": '3.0.3', + "info": { + "title": "SoftLayer API - OpenAPI 3.0", + "description": "SoftLayer API Definitions in a swagger format", + "termsOfService": "https://cloud.ibm.com/docs/overview?topic=overview-terms", + "version": "1.0.0" + }, + "externalDocs": { + "description": "SLDN", + "url": "https://sldn.softlayer.com" + }, + "servers": [ + {"url": "https://api.softlayer.com"}, + {"url": "https://api.service.softlayer.com"} + ], + "paths": {}, + "components": { + "schemas": {}, + "requestBodies": {}, + "securitySchemes": { + "api_key": { + "type": "apiKey", + "name": "api_key", + "in": "header" + } + } + } + } + + def getMetadata(self, url: str) -> dict: + """Downloads metadata from SLDN""" + response = requests.get(url) + if response.status_code != 200: + raise Exception(f"{url} returned \n{response.text}\nHTTP CODE: {response.status_code}") + + self.metajson = response.json() + return self.metajson + + def saveMetadata(self) -> None: + """Saves metadata to a file""" + print(f"Writing SLDN Metadata to {self.metapath}") + with open(self.metapath, 'w') as f: + json.dump(self.metajson, f, indent=4) + + def getLocalMetadata(self) -> dict: + """Loads metadata from local data folder""" + with open(self.metapath, "r", encoding="utf-8") as f: + metadata = f.read() + self.metajson = json.loads(metadata) + return self.metajson + + def addInORMMethods(self): + for serviceName, service in self.metajson.items(): + # noservice means datatype only. + if service.get('noservice', False) == False: + for propName, prop in service.get('properties', {}).items(): + if prop.get('form', '') == 'relational': + # capitlize() sadly lowercases the other letters in the string + ormName = f"get{propName[0].upper()}{propName[1:]}" + ormMethod = { + 'doc': prop.get('doc', ''), + 'docOverview': "", + 'name': ormName, + 'type': prop.get('type'), + 'typeArray': prop.get('typeArray', None), + 'ormMethod': True, + 'maskable': True, + 'filterable': True, + 'deprecated': prop.get('deprecated', False) + } + if ormMethod['typeArray']: + ormMethod['limitable'] = True + self.metajson[serviceName]['methods'][ormName] = ormMethod + return self.metajson + + def addInChildMethods(self): + for serviceName, service in self.metajson.items(): + self.metajson[serviceName]['methods'] = self.getBaseMethods(serviceName, 'methods') + self.metajson[serviceName]['properties'] = self.getBaseMethods(serviceName, 'properties') + + + def getBaseMethods(self, serviceName, objectType): + """Responsible for pulling in properties or methods from the base class of the service requested""" + service = self.metajson[serviceName] + methods = service.get(objectType, {}) + if service.get('base', "SoftLayer_Entity") != "SoftLayer_Entity": + + baseMethods = self.getBaseMethods(service.get('base'), objectType) + for bName, bMethod in baseMethods.items(): + if not methods.get(bName, False): + methods[bName] = bMethod + return methods + + def generate(self) -> None: + print("OK") + for serviceName, service in self.metajson.items(): + print(f"Working on {serviceName}") + # Writing the check this way to be more clear to myself when reading it + # This service has methods + if service.get('noservice', False) == False: + for methodName, method in service.get('methods', {}).items(): + self.openapi['paths'].update(self.genPath(serviceName, methodName, method)) + + + with open(f"{self.outdir}/sl_openapi.json", "w") as outfile: + json.dump(self.openapi, outfile, indent=4) + + def genPath(self, serviceName: str, methodName: str, method: dict) -> dict: + http_method = "get" + if method.get('parameters', False): + http_method = "post" + init_param = '' + if not method.get('static', False): + init_param = f"{{{serviceName}ID}}/" + + schema = method.get('type') + new_path = { + f"{serviceName}/{init_param}{methodName}": { + http_method: { + "description": method.get('doc'), + "summary": method.get('docOverview', ''), + "externalDocs": f"https://sldn.softlayer.com/reference/services/{serviceName}/{methodName}/", + "operationId": f"{serviceName}::{methodName}", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": self.getSchema(method) + } + } + } + }, + "security": [ + {"api_key": []} + ] + } + } + } + return new_path + + def getSchema(self, method: dict) -> dict: + """Gets a formatted schema object from a method""" + is_array = method.get('typeArray', False) + sl_type = method.get('type', "null") + ref = {} + if sl_type.startswith("SoftLayer_"): + ref = {"$ref": f"#/components/schemas/{sl_type}"} + else: + ref = {"type": sl_type} + if is_array: + schema = {"type": "array", "items": ref} + else: + schema = ref + return schema + + + +@click.command() +@click.option('--download', default=False, is_flag=True) +@click.option('--clean', default=False, is_flag=True, help="Removes the services and datatypes directories so they can be built from scratch") +def main(download: bool, clean: bool): + cwd = os.getcwd() + outdir = f'{cwd}/openapi' + if not cwd.endswith('githubio_source'): + raise Exception(f"Working Directory should be githubio_source, is currently {cwd}") + + if clean: + print(f"Removing {outdir}") + try: + shutil.rmtree(f'{outdir}') + except FileNotFoundError: + print("Directory doesnt exist...") + + generator = OpenAPIGen(outdir) + if download: + try: + metajson = generator.getMetadata(url = METAURL) + generator.addInChildMethods() + generator.addInORMMethods() + generator.saveMetadata() + except Exception as e: + print("========== ERROR ==========") + print(f"{e}") + print("========== ERROR ==========") + else: + metajson = generator.getLocalMetadata() + + print("Generating OpenAPI....") + generator.generate() + + +if __name__ == "__main__": + main() \ No newline at end of file diff --git a/openapi/openapi.json b/openapi/openapi.json new file mode 100644 index 0000000000..19fff4b1ca --- /dev/null +++ b/openapi/openapi.json @@ -0,0 +1,1231 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Swagger Petstore - OpenAPI 3.0", + "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [https://swagger.io](https://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\n_If you're looking for the Swagger 2.0/OAS 2.0 version of Petstore, then click [here](https://editor.swagger.io/?url=https://petstore.swagger.io/v2/swagger.yaml). Alternatively, you can load via the `Edit > Load Petstore OAS 2.0` menu option!_\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)", + "termsOfService": "http://swagger.io/terms/", + "contact": { + "email": "apiteam@swagger.io" + }, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.11" + }, + "externalDocs": { + "description": "Find out more about Swagger", + "url": "http://swagger.io" + }, + "servers": [ + { + "url": "https://petstore3.swagger.io/api/v3" + } + ], + "tags": [ + { + "name": "pet", + "description": "Everything about your Pets", + "externalDocs": { + "description": "Find out more", + "url": "http://swagger.io" + } + }, + { + "name": "store", + "description": "Access to Petstore orders", + "externalDocs": { + "description": "Find out more about our store", + "url": "http://swagger.io" + } + }, + { + "name": "user", + "description": "Operations about user" + } + ], + "paths": { + "/pet": { + "put": { + "tags": [ + "pet" + ], + "summary": "Update an existing pet", + "description": "Update an existing pet by Id", + "operationId": "updatePet", + "requestBody": { + "description": "Update an existent pet in the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "Invalid ID supplied" + }, + "404": { + "description": "Pet not found" + }, + "422": { + "description": "Validation exception" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "post": { + "tags": [ + "pet" + ], + "summary": "Add a new pet to the store", + "description": "Add a new pet to the store", + "operationId": "addPet", + "requestBody": { + "description": "Create a new pet in the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "Invalid input" + }, + "422": { + "description": "Validation exception" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/findByStatus": { + "get": { + "tags": [ + "pet" + ], + "summary": "Finds Pets by status", + "description": "Multiple status values can be provided with comma separated strings", + "operationId": "findPetsByStatus", + "parameters": [ + { + "name": "status", + "in": "query", + "description": "Status values that need to be considered for filter", + "required": false, + "explode": true, + "schema": { + "type": "string", + "default": "available", + "enum": [ + "available", + "pending", + "sold" + ] + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "application/xml": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "400": { + "description": "Invalid status value" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/findByTags": { + "get": { + "tags": [ + "pet" + ], + "summary": "Finds Pets by tags", + "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", + "operationId": "findPetsByTags", + "parameters": [ + { + "name": "tags", + "in": "query", + "description": "Tags to filter by", + "required": false, + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "application/xml": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "400": { + "description": "Invalid tag value" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/{petId}": { + "get": { + "tags": [ + "pet" + ], + "summary": "Find pet by ID", + "description": "Returns a single pet", + "operationId": "getPetById", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ID of pet to return", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "Invalid ID supplied" + }, + "404": { + "description": "Pet not found" + } + }, + "security": [ + { + "api_key": [] + }, + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "post": { + "tags": [ + "pet" + ], + "summary": "Updates a pet in the store with form data", + "description": "", + "operationId": "updatePetWithForm", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ID of pet that needs to be updated", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "name", + "in": "query", + "description": "Name of pet that needs to be updated", + "schema": { + "type": "string" + } + }, + { + "name": "status", + "in": "query", + "description": "Status of pet that needs to be updated", + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "Invalid input" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "delete": { + "tags": [ + "pet" + ], + "summary": "Deletes a pet", + "description": "delete a pet", + "operationId": "deletePet", + "parameters": [ + { + "name": "api_key", + "in": "header", + "description": "", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "petId", + "in": "path", + "description": "Pet id to delete", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Invalid pet value" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/{petId}/uploadImage": { + "post": { + "tags": [ + "pet" + ], + "summary": "uploads an image", + "description": "", + "operationId": "uploadFile", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ID of pet to update", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "additionalMetadata", + "in": "query", + "description": "Additional Metadata", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + } + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/store/inventory": { + "get": { + "tags": [ + "store" + ], + "summary": "Returns pet inventories by status", + "description": "Returns a map of status codes to quantities", + "operationId": "getInventory", + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/store/order": { + "post": { + "tags": [ + "store" + ], + "summary": "Place an order for a pet", + "description": "Place a new order in the store", + "operationId": "placeOrder", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "400": { + "description": "Invalid input" + }, + "422": { + "description": "Validation exception" + } + } + } + }, + "/store/order/{orderId}": { + "get": { + "tags": [ + "store" + ], + "summary": "Find purchase order by ID", + "description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.", + "operationId": "getOrderById", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "ID of order that needs to be fetched", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "400": { + "description": "Invalid ID supplied" + }, + "404": { + "description": "Order not found" + } + } + }, + "delete": { + "tags": [ + "store" + ], + "summary": "Delete purchase order by ID", + "description": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors", + "operationId": "deleteOrder", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "ID of the order that needs to be deleted", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Invalid ID supplied" + }, + "404": { + "description": "Order not found" + } + } + } + }, + "/user": { + "post": { + "tags": [ + "user" + ], + "summary": "Create user", + "description": "This can only be done by the logged in user.", + "operationId": "createUser", + "requestBody": { + "description": "Created user object", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "default": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "/user/createWithList": { + "post": { + "tags": [ + "user" + ], + "summary": "Creates list of users with given input array", + "description": "Creates list of users with given input array", + "operationId": "createUsersWithListInput", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "default": { + "description": "successful operation" + } + } + } + }, + "/user/login": { + "get": { + "tags": [ + "user" + ], + "summary": "Logs user into the system", + "description": "", + "operationId": "loginUser", + "parameters": [ + { + "name": "username", + "in": "query", + "description": "The user name for login", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "password", + "in": "query", + "description": "The password for login in clear text", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "X-Rate-Limit": { + "description": "calls per hour allowed by the user", + "schema": { + "type": "integer", + "format": "int32" + } + }, + "X-Expires-After": { + "description": "date in UTC when token expires", + "schema": { + "type": "string", + "format": "date-time" + } + } + }, + "content": { + "application/xml": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Invalid username/password supplied" + } + } + } + }, + "/user/logout": { + "get": { + "tags": [ + "user" + ], + "summary": "Logs out current logged in user session", + "description": "", + "operationId": "logoutUser", + "parameters": [], + "responses": { + "default": { + "description": "successful operation" + } + } + } + }, + "/user/{username}": { + "get": { + "tags": [ + "user" + ], + "summary": "Get user by user name", + "description": "", + "operationId": "getUserByName", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "The name that needs to be fetched. Use user1 for testing. ", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "400": { + "description": "Invalid username supplied" + }, + "404": { + "description": "User not found" + } + } + }, + "put": { + "tags": [ + "user" + ], + "summary": "Update user", + "description": "This can only be done by the logged in user.", + "operationId": "updateUser", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "name that need to be deleted", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update an existent user in the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "default": { + "description": "successful operation" + } + } + }, + "delete": { + "tags": [ + "user" + ], + "summary": "Delete user", + "description": "This can only be done by the logged in user.", + "operationId": "deleteUser", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "The name that needs to be deleted", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "Invalid username supplied" + }, + "404": { + "description": "User not found" + } + } + } + } + }, + "components": { + "schemas": { + "Order": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "petId": { + "type": "integer", + "format": "int64", + "example": 198772 + }, + "quantity": { + "type": "integer", + "format": "int32", + "example": 7 + }, + "shipDate": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "description": "Order Status", + "example": "approved", + "enum": [ + "placed", + "approved", + "delivered" + ] + }, + "complete": { + "type": "boolean" + } + }, + "xml": { + "name": "order" + } + }, + "Customer": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 100000 + }, + "username": { + "type": "string", + "example": "fehguy" + }, + "address": { + "type": "array", + "xml": { + "name": "addresses", + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/Address" + } + } + }, + "xml": { + "name": "customer" + } + }, + "Address": { + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "437 Lytton" + }, + "city": { + "type": "string", + "example": "Palo Alto" + }, + "state": { + "type": "string", + "example": "CA" + }, + "zip": { + "type": "string", + "example": "94301" + } + }, + "xml": { + "name": "address" + } + }, + "Category": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "type": "string", + "example": "Dogs" + } + }, + "xml": { + "name": "category" + } + }, + "User": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "username": { + "type": "string", + "example": "theUser" + }, + "firstName": { + "type": "string", + "example": "John" + }, + "lastName": { + "type": "string", + "example": "James" + }, + "email": { + "type": "string", + "example": "john@email.com" + }, + "password": { + "type": "string", + "example": "12345" + }, + "phone": { + "type": "string", + "example": "12345" + }, + "userStatus": { + "type": "integer", + "description": "User Status", + "format": "int32", + "example": 1 + } + }, + "xml": { + "name": "user" + } + }, + "Tag": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + }, + "xml": { + "name": "tag" + } + }, + "Pet": { + "required": [ + "name", + "photoUrls" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "name": { + "type": "string", + "example": "doggie" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "photoUrls": { + "type": "array", + "xml": { + "wrapped": true + }, + "items": { + "type": "string", + "xml": { + "name": "photoUrl" + } + } + }, + "tags": { + "type": "array", + "xml": { + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "status": { + "type": "string", + "description": "pet status in the store", + "enum": [ + "available", + "pending", + "sold" + ] + } + }, + "xml": { + "name": "pet" + } + }, + "ApiResponse": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "xml": { + "name": "##default" + } + } + }, + "requestBodies": { + "Pet": { + "description": "Pet object that needs to be added to the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "UserArray": { + "description": "List of user object", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + }, + "securitySchemes": { + "petstore_auth": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://petstore3.swagger.io/oauth/authorize", + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } + } + } + }, + "api_key": { + "type": "apiKey", + "name": "api_key", + "in": "header" + } + } + } +} \ No newline at end of file diff --git a/openapi/sl_openapi.json b/openapi/sl_openapi.json new file mode 100644 index 0000000000..2f6725e9e7 --- /dev/null +++ b/openapi/sl_openapi.json @@ -0,0 +1,147303 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "SoftLayer API - OpenAPI 3.0", + "description": "SoftLayer API Definitions in a swagger format", + "termsOfService": "https://cloud.ibm.com/docs/overview?topic=overview-terms", + "version": "1.0.0" + }, + "externalDocs": { + "description": "SLDN", + "url": "https://sldn.softlayer.com" + }, + "servers": [ + { + "url": "https://api.softlayer.com" + }, + { + "url": "https://api.service.softlayer.com" + } + ], + "paths": { + "BluePages_Search/findBluePagesProfile": { + "post": { + "description": "Given an IBM email address, searches BluePages and returns the employee's details. Note that this method is not available to customers, despite being visible, and will return an error response. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/BluePages_Search/findBluePagesProfile/", + "operationId": "BluePages_Search::findBluePagesProfile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "BluePages_Container_EmployeeProfile" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "IntegratedOfferingTeam_Region/getAllObjects": { + "get": { + "description": "Returns a list of all Integrated Offering Team regions. Note that this method, despite being visible, is not accessible by customers and attempting to use it will result in an error response. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/IntegratedOfferingTeam_Region/getAllObjects/", + "operationId": "IntegratedOfferingTeam_Region::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "IntegratedOfferingTeam_Container_Region" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "IntegratedOfferingTeam_Region/getRegionLeads": { + "get": { + "description": "Returns a list of all Integrated Offering Team region leads. Note that this method, despite being visible, is not accessible by customers and attempting to use it will result in an error response. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/IntegratedOfferingTeam_Region/getRegionLeads/", + "operationId": "IntegratedOfferingTeam_Region::getRegionLeads", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "IntegratedOfferingTeam_Container_Region_Lead" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/activatePartner": { + "post": { + "description": null, + "summary": "This service enables a partner account that has been created but is currently inactive. This restricted service is only available for certain accounts. Please contact support for questions. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/activatePartner/", + "operationId": "SoftLayer_Account::activatePartner", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/addAchInformation": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/addAchInformation/", + "operationId": "SoftLayer_Account::addAchInformation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/addReferralPartnerPaymentOption": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/addReferralPartnerPaymentOption/", + "operationId": "SoftLayer_Account::addReferralPartnerPaymentOption", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/areVdrUpdatesBlockedForBilling": { + "get": { + "description": "This method indicates whether or not Bandwidth Pooling updates are blocked for the account so the billing cycle can run. Generally, accounts are restricted from moving servers in or out of Bandwidth Pools from 12:00 CST on the day prior to billing, until the billing batch completes, sometime after midnight the day of actual billing for the account. ", + "summary": "This method returns true if Bandwidth Pooling updates are blocked so billing can run for this account.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/areVdrUpdatesBlockedForBilling/", + "operationId": "SoftLayer_Account::areVdrUpdatesBlockedForBilling", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/cancelPayPalTransaction": { + "post": { + "description": "Cancel the PayPal Payment Request process. During the process of submitting a PayPal payment request, the customer is redirected to PayPal to confirm the request. If the customer elects to cancel the payment from PayPal, they are returned to SoftLayer where the manual payment record is updated to a status of canceled. ", + "summary": "Cancel the PayPal Payment Request process.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/cancelPayPalTransaction/", + "operationId": "SoftLayer_Account::cancelPayPalTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/completePayPalTransaction": { + "post": { + "description": "Complete the PayPal Payment Request process and receive confirmation message. During the process of submitting a PayPal payment request, the customer is redirected to PayPal to confirm the request. Once confirmed, PayPal returns the customer to SoftLayer where an attempt is made to finalize the transaction. A status message regarding the attempt is returned to the calling function. ", + "summary": "Complete the PayPal Payment Request process and receive confirmation message.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/completePayPalTransaction/", + "operationId": "SoftLayer_Account::completePayPalTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/countHourlyInstances": { + "get": { + "description": "Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached. ", + "summary": "Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/countHourlyInstances/", + "operationId": "SoftLayer_Account::countHourlyInstances", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/createUser": { + "post": { + "description": "Create a new Customer user record in the SoftLayer customer portal. This is a wrapper around the Customer::createObject call, please see the documentation of that API. This wrapper adds the feature of the \"silentlyCreate\" option, which bypasses the IBMid invitation email process. False (the default) goes through the IBMid invitation email process, which creates the IBMid/SoftLayer Single-Sign-On (SSO) user link when the invitation is accepted (meaning the email has been received, opened, and the link(s) inside the email have been clicked to complete the process). True will silently (no email) create the IBMid/SoftLayer user SSO link immediately. Either case will use the value in the template object 'email' field to indicate the IBMid to use. This can be the username or, if unique, the email address of an IBMid. In the silent case, the IBMid must already exist. In the non-silent invitation email case, the IBMid can be created during this flow, by specifying an email address to be used to create the IBMid.All the features and restrictions of createObject apply to this API as well. In addition, note that the \"silentlyCreate\" flag is ONLY valid for IBMid-authenticated accounts. ", + "summary": "Create a new user record, optionally skipping the IBMid email (\"silently\").", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/createUser/", + "operationId": "SoftLayer_Account::createUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/disableEuSupport": { + "get": { + "description": "

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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/disableEuSupport/", + "operationId": "SoftLayer_Account::disableEuSupport", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/disableVpnConfigRequiresVpnManageAttribute/", + "operationId": "SoftLayer_Account::disableVpnConfigRequiresVpnManageAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "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:

", + "summary": "Edit an account's information.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/editAccount/", + "operationId": "SoftLayer_Account::editAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Account_Update_Response" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/enableEuSupport": { + "get": { + "description": "

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\n

Important 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\n

If 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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/enableEuSupport/", + "operationId": "SoftLayer_Account::enableEuSupport", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/enableVpnConfigRequiresVpnManageAttribute/", + "operationId": "SoftLayer_Account::enableVpnConfigRequiresVpnManageAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Account/getAccountTraitValue": { + "post": { + "description": "This method pulls an account trait by its key. ", + "summary": "Get the specific trait by its key", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account/getActiveOutletPackages": { + "get": { + "description": "This is deprecated and will not return any results. ", + "summary": "DEPRECATED. This method will return nothing.", + "externalDocs": "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": "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": "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": [] + } + ] + } + }, + "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": "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": "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": "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": [] + } + ] + } + }, + "SoftLayer_Account/getAuxiliaryNotifications": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate/", + "operationId": "SoftLayer_Account::getAverageArchiveUsageMetricDataByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate/", + "operationId": "SoftLayer_Account::getAveragePublicUsageMetricDataByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/getBandwidthList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Account/getHardwarePools": { + "get": { + "description": "Return a collection of managed hardware pools.", + "summary": "Get a collection of managed hardware pools.", + "externalDocs": "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLargestAllowedSubnetCidr/", + "operationId": "SoftLayer_Account::getLargestAllowedSubnetCidr", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceExcel/", + "operationId": "SoftLayer_Account::getNextInvoiceExcel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoicePdf/", + "operationId": "SoftLayer_Account::getNextInvoicePdf", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoicePdfDetailed/", + "operationId": "SoftLayer_Account::getNextInvoicePdfDetailed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/getNextInvoiceZeroFeeItemCounts": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": "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": "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": "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": "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": "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": "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": [] + } + ] + } + }, + "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": "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": "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": "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": "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": "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": [] + } + ] + } + }, + "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/hourlyInstanceLimit/", + "operationId": "SoftLayer_Account::hourlyInstanceLimit", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/hourlyServerLimit/", + "operationId": "SoftLayer_Account::hourlyServerLimit", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "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": "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/linkExternalAccount/", + "operationId": "SoftLayer_Account::linkExternalAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/removeAlternateCreditCard": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Account/saveInternalCostRecovery": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/saveInternalCostRecovery/", + "operationId": "SoftLayer_Account::saveInternalCostRecovery", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/setManagedPoolQuantity/", + "operationId": "SoftLayer_Account::setManagedPoolQuantity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Account/swapCreditCards": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/syncCurrentUserPopulationWithPaas/", + "operationId": "SoftLayer_Account::syncCurrentUserPopulationWithPaas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/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": "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/{SoftLayer_AccountID}/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": "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/{SoftLayer_AccountID}/getAccountContacts": { + "get": { + "description": "The account contacts on an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAccountLicenses": { + "get": { + "description": "The account software licenses owned by an account", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAccountLinks": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAccountStatus": { + "get": { + "description": "An account's status presented in a more detailed data type.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveAccountDiscountBillingItem": { + "get": { + "description": "The billing item associated with an account's monthly discount.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveAccountLicenses": { + "get": { + "description": "The active account software licenses owned by an account", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveAddresses": { + "get": { + "description": "The active address(es) that belong to an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveAgreements": { + "get": { + "description": "All active agreements for an account", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveBillingAgreements": { + "get": { + "description": "All billing agreements for an account", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveCatalystEnrollment": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveColocationContainers": { + "get": { + "description": "Deprecated.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveFlexibleCreditEnrollment": { + "get": { + "description": "[Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveFlexibleCreditEnrollments": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveNotificationSubscribers": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveQuotes": { + "get": { + "description": "An account's non-expired quotes.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveReservedCapacityAgreements": { + "get": { + "description": "Active reserved capacity agreements for an account", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getActiveVirtualLicenses": { + "get": { + "description": "The virtual software licenses controlled by an account", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAdcLoadBalancers": { + "get": { + "description": "An account's associated load balancers.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAddresses": { + "get": { + "description": "All the address(es) that belong to an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAffiliateId": { + "get": { + "description": "An affiliate identifier associated with the customer account. ", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAllBillingItems": { + "get": { + "description": "The billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAllCommissionBillingItems": { + "get": { + "description": "The billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAllRecurringTopLevelBillingItems": { + "get": { + "description": "The billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAllRecurringTopLevelBillingItemsUnfiltered": { + "get": { + "description": "The billing items that will be on an account's next invoice. Does not consider associated items.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAllSubnetBillingItems": { + "get": { + "description": "The billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAllTopLevelBillingItems": { + "get": { + "description": "All billing items of an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAllTopLevelBillingItemsUnfiltered": { + "get": { + "description": "The billing items that will be on an account's next invoice. Does not consider associated items.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAllowIbmIdSilentMigrationFlag": { + "get": { + "description": "Indicates whether this account is allowed to silently migrate to use IBMid Authentication.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAllowsBluemixAccountLinkingFlag": { + "get": { + "description": "Flag indicating if this account can be linked with Bluemix.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getApplicationDeliveryControllers": { + "get": { + "description": "An account's associated application delivery controller records.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAttributes": { + "get": { + "description": "The account attribute values for a SoftLayer customer account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getAvailablePublicNetworkVlans": { + "get": { + "description": "The public network VLANs assigned to an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getBalance/", + "operationId": "SoftLayer_Account::getBalance", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getBandwidthAllotments": { + "get": { + "description": "The bandwidth allotments for an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBandwidthAllotmentsOverAllocation": { + "get": { + "description": "The bandwidth allotments for an account currently over allocation.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBandwidthAllotmentsProjectedOverAllocation": { + "get": { + "description": "The bandwidth allotments for an account projected to go over allocation.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBareMetalInstances": { + "get": { + "description": "An account's associated bare metal server objects.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBillingAgreements": { + "get": { + "description": "All billing agreements for an account", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBillingInfo": { + "get": { + "description": "An account's billing information.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBlockDeviceTemplateGroups": { + "get": { + "description": "Private template group objects (parent and children) and the shared template group objects (parent only) for an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/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": "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/{SoftLayer_AccountID}/getBluemixAccountId": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBluemixAccountLink": { + "get": { + "description": "The Platform account link associated with this SoftLayer account, if one exists.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBluemixLinkedFlag": { + "get": { + "description": "Returns true if this account is linked to IBM Bluemix, false if not.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBrand": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBrandAccountFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBrandKeyName": { + "get": { + "description": "The brand keyName.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getBusinessPartner": { + "get": { + "description": "The Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getCanOrderAdditionalVlansFlag": { + "get": { + "description": "[DEPRECATED] All accounts may order VLANs.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getCarts": { + "get": { + "description": "An account's active carts.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getCatalystEnrollments": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getClosedTickets": { + "get": { + "description": "All closed tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getDatacentersWithSubnetAllocations": { + "get": { + "description": "Datacenters which contain subnets that the account has access to route.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getDedicatedHosts": { + "get": { + "description": "An account's associated virtual dedicated host objects.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getDisablePaymentProcessingFlag": { + "get": { + "description": "A flag indicating whether payments are processed for this account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getDisplaySupportRepresentativeAssignments": { + "get": { + "description": "The SoftLayer employees that an account is assigned to.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getDomains": { + "get": { + "description": "The DNS domains associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/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": "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/{SoftLayer_AccountID}/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": "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/{SoftLayer_AccountID}/getEvaultCapacityGB": { + "get": { + "description": "The total capacity of Legacy EVault Volumes on an account, in GB.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getEvaultCapacityGB/", + "operationId": "SoftLayer_Account::getEvaultCapacityGB", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getEvaultMasterUsers": { + "get": { + "description": "An account's master EVault user. This is only used when an account has EVault service.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getEvaultNetworkStorage": { + "get": { + "description": "An account's associated EVault storage volumes.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getExpiredSecurityCertificates": { + "get": { + "description": "Stored security certificates that are expired (ie. SSL)", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/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": "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/{SoftLayer_AccountID}/getFileBlockBetaAccessFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getFlexibleCreditEnrollments": { + "get": { + "description": "All of the account's current and former Flexible Credit enrollments.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getForcePaasAccountLinkDate": { + "get": { + "description": "Timestamp representing the point in time when an account is required to link with PaaS.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getGlobalIpRecords": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getGlobalIpv4Records": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getGlobalIpv6Records": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardware": { + "get": { + "description": "An account's associated hardware objects.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareOverBandwidthAllocation": { + "get": { + "description": "An account's associated hardware objects currently over bandwidth allocation.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareProjectedOverBandwidthAllocation": { + "get": { + "description": "An account's associated hardware objects projected to go over bandwidth allocation.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareWithCpanel": { + "get": { + "description": "All hardware associated with an account that has the cPanel web hosting control panel installed.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareWithHelm": { + "get": { + "description": "All hardware associated with an account that has the Helm web hosting control panel installed.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareWithMcafee": { + "get": { + "description": "All hardware associated with an account that has McAfee Secure software components.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareWithMcafeeAntivirusRedhat": { + "get": { + "description": "All hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareWithMcafeeAntivirusWindows": { + "get": { + "description": "All hardware associated with an account that has McAfee Secure AntiVirus for Windows software components.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareWithMcafeeIntrusionDetectionSystem": { + "get": { + "description": "All hardware associated with an account that has McAfee Secure Intrusion Detection System software components.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareWithPlesk": { + "get": { + "description": "All hardware associated with an account that has the Plesk web hosting control panel installed.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareWithQuantastor": { + "get": { + "description": "All hardware associated with an account that has the QuantaStor storage system installed.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareWithUrchin": { + "get": { + "description": "All hardware associated with an account that has the Urchin web traffic analytics package installed.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHardwareWithWindows": { + "get": { + "description": "All hardware associated with an account that is running a version of the Microsoft Windows operating system.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHasEvaultBareMetalRestorePluginFlag": { + "get": { + "description": "Return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHasIderaBareMetalRestorePluginFlag": { + "get": { + "description": "Return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHasPendingOrder": { + "get": { + "description": "The number of orders in a PENDING status for a SoftLayer customer account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getHasPendingOrder/", + "operationId": "SoftLayer_Account::getHasPendingOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getHasR1softBareMetalRestorePluginFlag": { + "get": { + "description": "Return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHourlyBareMetalInstances": { + "get": { + "description": "An account's associated hourly bare metal server objects.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHourlyServiceBillingItems": { + "get": { + "description": "Hourly service billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHourlyVirtualGuests": { + "get": { + "description": "An account's associated hourly virtual guest objects.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getHubNetworkStorage": { + "get": { + "description": "An account's associated Virtual Storage volumes.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getIbmCustomerNumber": { + "get": { + "description": "Unique identifier for a customer used throughout IBM.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getIbmIdAuthenticationRequiredFlag": { + "get": { + "description": "Indicates whether this account requires IBMid authentication.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getIbmIdMigrationExpirationTimestamp": { + "get": { + "description": "This key is deprecated and should not be used.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getInProgressExternalAccountSetup": { + "get": { + "description": "An in progress request to switch billing systems.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getInternalCciHostAccountFlag": { + "get": { + "description": "Account attribute flag indicating internal cci host account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getInternalImageTemplateCreationFlag": { + "get": { + "description": "Account attribute flag indicating account creates internal image templates.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getInternalNotes": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getInternalRestrictionFlag": { + "get": { + "description": "Account attribute flag indicating restricted account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getInvoices": { + "get": { + "description": "An account's associated billing invoices.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getIpAddresses": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getIscsiIsolationDisabled": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getIscsiNetworkStorage": { + "get": { + "description": "An account's associated iSCSI storage volumes.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getLastCanceledBillingItem": { + "get": { + "description": "The most recently canceled billing item.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getLastCancelledServerBillingItem": { + "get": { + "description": "The most recent cancelled server billing item.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getLastFiveClosedAbuseTickets": { + "get": { + "description": "The five most recently closed abuse tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getLastFiveClosedAccountingTickets": { + "get": { + "description": "The five most recently closed accounting tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/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": "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/{SoftLayer_AccountID}/getLastFiveClosedSalesTickets": { + "get": { + "description": "The five most recently closed sales tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getLastFiveClosedSupportTickets": { + "get": { + "description": "The five most recently closed support tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getLastFiveClosedTickets": { + "get": { + "description": "The five most recently closed tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getLatestBillDate": { + "get": { + "description": "An account's most recent billing date.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLatestBillDate/", + "operationId": "SoftLayer_Account::getLatestBillDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getLatestRecurringInvoice": { + "get": { + "description": "An account's latest recurring invoice.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getLatestRecurringPendingInvoice": { + "get": { + "description": "An account's latest recurring pending invoice.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getLegacyIscsiCapacityGB": { + "get": { + "description": "The total capacity of Legacy iSCSI Volumes on an account, in GB.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLegacyIscsiCapacityGB/", + "operationId": "SoftLayer_Account::getLegacyIscsiCapacityGB", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getLoadBalancers": { + "get": { + "description": "An account's associated load balancers.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getLockboxCapacityGB": { + "get": { + "description": "The total capacity of Legacy lockbox Volumes on an account, in GB.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getLockboxCapacityGB/", + "operationId": "SoftLayer_Account::getLockboxCapacityGB", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getLockboxNetworkStorage": { + "get": { + "description": "An account's associated Lockbox storage volumes.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getManualPaymentsUnderReview": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getMasterUser": { + "get": { + "description": "An account's master user.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getMediaDataTransferRequests": { + "get": { + "description": "An account's media transfer service requests.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getMigratedToIbmCloudPortalFlag": { + "get": { + "description": "Flag indicating whether this account is restricted to the IBM Cloud portal.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getMonthlyBareMetalInstances": { + "get": { + "description": "An account's associated monthly bare metal server objects.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getMonthlyVirtualGuests": { + "get": { + "description": "An account's associated monthly virtual guest objects.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNasNetworkStorage": { + "get": { + "description": "An account's associated NAS storage volumes.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkCreationFlag": { + "get": { + "description": "[Deprecated] Whether or not this account can define their own networks.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkGateways": { + "get": { + "description": "All network gateway devices on this account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkHardware": { + "get": { + "description": "An account's associated network hardware.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkMessageDeliveryAccounts": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkMonitorDownHardware": { + "get": { + "description": "Hardware which is currently experiencing a service failure.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkMonitorDownVirtualGuests": { + "get": { + "description": "Virtual guest which is currently experiencing a service failure.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkMonitorRecoveringHardware": { + "get": { + "description": "Hardware which is currently recovering from a service failure.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkMonitorRecoveringVirtualGuests": { + "get": { + "description": "Virtual guest which is currently recovering from a service failure.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkMonitorUpHardware": { + "get": { + "description": "Hardware which is currently online.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkMonitorUpVirtualGuests": { + "get": { + "description": "Virtual guest which is currently online.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkStorage": { + "get": { + "description": "An account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkStorageGroups": { + "get": { + "description": "An account's Network Storage groups.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkTunnelContexts": { + "get": { + "description": "IPSec network tunnels for an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkVlanSpan": { + "get": { + "description": "Whether or not an account has automatic private VLAN spanning enabled.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getNetworkVlans": { + "get": { + "description": "All network VLANs assigned to an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceIncubatorExemptTotal/", + "operationId": "SoftLayer_Account::getNextInvoiceIncubatorExemptTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getNextInvoicePlatformServicesTotalAmount": { + "get": { + "description": "The pre-tax platform services total amount of an account's next invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoicePlatformServicesTotalAmount/", + "operationId": "SoftLayer_Account::getNextInvoicePlatformServicesTotalAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceRecurringAmountEligibleForAccountDiscount/", + "operationId": "SoftLayer_Account::getNextInvoiceRecurringAmountEligibleForAccountDiscount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getNextInvoiceTopLevelBillingItems": { + "get": { + "description": "The billing items that will be on an account's next invoice.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalAmount/", + "operationId": "SoftLayer_Account::getNextInvoiceTotalAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeAmount/", + "operationId": "SoftLayer_Account::getNextInvoiceTotalOneTimeAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeTaxAmount/", + "operationId": "SoftLayer_Account::getNextInvoiceTotalOneTimeTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmount/", + "operationId": "SoftLayer_Account::getNextInvoiceTotalRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmountBeforeAccountDiscount/", + "operationId": "SoftLayer_Account::getNextInvoiceTotalRecurringAmountBeforeAccountDiscount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringTaxAmount/", + "operationId": "SoftLayer_Account::getNextInvoiceTotalRecurringTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getNextInvoiceTotalTaxableRecurringAmount/", + "operationId": "SoftLayer_Account::getNextInvoiceTotalTaxableRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getNotificationSubscribers": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenAbuseTickets": { + "get": { + "description": "The open abuse tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenAccountingTickets": { + "get": { + "description": "The open accounting tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenBillingTickets": { + "get": { + "description": "The open billing tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenCancellationRequests": { + "get": { + "description": "An open ticket requesting cancellation of this server, if one exists.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenOtherTickets": { + "get": { + "description": "The open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenRecurringInvoices": { + "get": { + "description": "An account's recurring invoices.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenSalesTickets": { + "get": { + "description": "The open sales tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenStackAccountLinks": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenStackObjectStorage": { + "get": { + "description": "An account's associated Openstack related Object Storage accounts.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenSupportTickets": { + "get": { + "description": "The open support tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenTickets": { + "get": { + "description": "All open tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOpenTicketsWaitingOnCustomer": { + "get": { + "description": "All open tickets associated with an account last edited by an employee.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOrders": { + "get": { + "description": "An account's associated billing orders excluding upgrades.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/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": "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/{SoftLayer_AccountID}/getOwnedBrands": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getOwnedHardwareGenericComponentModels": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPaymentProcessors": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPendingEvents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPendingInvoice": { + "get": { + "description": "An account's latest open (pending) invoice.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPendingInvoiceTopLevelItems": { + "get": { + "description": "A list of top-level invoice items that are on an account's currently pending invoice.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPendingInvoiceTotalAmount": { + "get": { + "description": "The total amount of an account's pending invoice, if one exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTotalAmount/", + "operationId": "SoftLayer_Account::getPendingInvoiceTotalAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeAmount/", + "operationId": "SoftLayer_Account::getPendingInvoiceTotalOneTimeAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeTaxAmount/", + "operationId": "SoftLayer_Account::getPendingInvoiceTotalOneTimeTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getPendingInvoiceTotalRecurringAmount": { + "get": { + "description": "The total recurring amount of an account's pending invoice, if one exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringAmount/", + "operationId": "SoftLayer_Account::getPendingInvoiceTotalRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getPendingInvoiceTotalRecurringTaxAmount": { + "get": { + "description": "The total amount of the recurring taxes on an account's pending invoice, if one exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringTaxAmount/", + "operationId": "SoftLayer_Account::getPendingInvoiceTotalRecurringTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getPermissionGroups": { + "get": { + "description": "An account's permission groups.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPermissionRoles": { + "get": { + "description": "An account's user roles.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPlacementGroups": { + "get": { + "description": "An account's associated virtual placement groups.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPortableStorageVolumes": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/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": "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/{SoftLayer_AccountID}/getPptpVpnAllowedFlag": { + "get": { + "description": "(Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPptpVpnUsers": { + "get": { + "description": "An account's associated portal users with PPTP VPN access. (Deprecated)", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPreOpenRecurringInvoices": { + "get": { + "description": "An account's invoices in the PRE_OPEN status.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPreviousRecurringRevenue": { + "get": { + "description": "The total recurring amount for an accounts previous revenue.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account/getPreviousRecurringRevenue/", + "operationId": "SoftLayer_Account::getPreviousRecurringRevenue", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account/{SoftLayer_AccountID}/getPriceRestrictions": { + "get": { + "description": "The item price that an account is restricted to.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPriorityOneTickets": { + "get": { + "description": "All priority one tickets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPrivateBlockDeviceTemplateGroups": { + "get": { + "description": "Private and shared template group objects (parent only) for an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPrivateIpAddresses": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPrivateNetworkVlans": { + "get": { + "description": "The private network VLANs assigned to an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPrivateSubnets": { + "get": { + "description": "All private subnets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getProofOfConceptAccountFlag": { + "get": { + "description": "Boolean flag indicating whether or not this account is a Proof of Concept account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPublicIpAddresses": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPublicNetworkVlans": { + "get": { + "description": "The public network VLANs assigned to an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getPublicSubnets": { + "get": { + "description": "All public network subnets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getQuotes": { + "get": { + "description": "An account's quotes.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getRecentEvents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getReferralPartner": { + "get": { + "description": "The Referral Partner for this account, if any.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getReferredAccountFlag": { + "get": { + "description": "Flag indicating if the account was referred.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getReferredAccounts": { + "get": { + "description": "If this is a account is a referral partner, the accounts this referral partner has referred", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getRegulatedWorkloads": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getRemoteManagementCommandRequests": { + "get": { + "description": "Remote management command requests for an account", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getReplicationEvents": { + "get": { + "description": "The Replication events for all Network Storage volumes on an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/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": "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/{SoftLayer_AccountID}/getReservedCapacityAgreements": { + "get": { + "description": "All reserved capacity agreements for an account", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getReservedCapacityGroups": { + "get": { + "description": "The reserved capacity groups owned by this account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getRouters": { + "get": { + "description": "All Routers that an accounts VLANs reside on", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getRwhoisData": { + "get": { + "description": "DEPRECATED", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSamlAuthentication": { + "get": { + "description": "The SAML configuration for this account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSecondaryDomains": { + "get": { + "description": "The secondary DNS records for a SoftLayer customer account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSecurityCertificates": { + "get": { + "description": "Stored security certificates (ie. SSL)", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSecurityGroups": { + "get": { + "description": "The security groups belonging to this account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSecurityLevel": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSecurityScanRequests": { + "get": { + "description": "An account's vulnerability scan requests.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getServiceBillingItems": { + "get": { + "description": "The service billing items that will be on an account's next invoice. ", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getShipments": { + "get": { + "description": "Shipments that belong to the customer's account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSshKeys": { + "get": { + "description": "Customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSslVpnUsers": { + "get": { + "description": "An account's associated portal users with SSL VPN access.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getStandardPoolVirtualGuests": { + "get": { + "description": "An account's virtual guest objects that are hosted on a user provisioned hypervisor.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSubnetRegistrationDetails": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSubnetRegistrations": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSubnets": { + "get": { + "description": "All network subnets associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSupportRepresentatives": { + "get": { + "description": "The SoftLayer employees that an account is assigned to.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSupportSubscriptions": { + "get": { + "description": "The active support subscriptions for this account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSupportTier": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getSuppressInvoicesFlag": { + "get": { + "description": "A flag indicating to suppress invoices.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getTags": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getTestAccountAttributeFlag": { + "get": { + "description": "Account attribute flag indicating test account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getTickets": { + "get": { + "description": "An account's associated tickets.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getTicketsClosedInTheLastThreeDays": { + "get": { + "description": "Tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getTicketsClosedToday": { + "get": { + "description": "Tickets closed today associated with an account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getUpgradeRequests": { + "get": { + "description": "An account's associated upgrade requests.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getUsers": { + "get": { + "description": "An account's portal users.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getValidSecurityCertificates": { + "get": { + "description": "Stored security certificates that are not expired (ie. SSL)", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualDedicatedRacks": { + "get": { + "description": "The bandwidth pooling for this account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualDiskImages": { + "get": { + "description": "An account's associated virtual server virtual disk images.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuests": { + "get": { + "description": "An account's associated virtual guest objects.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuestsOverBandwidthAllocation": { + "get": { + "description": "An account's associated virtual guest objects currently over bandwidth allocation.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuestsProjectedOverBandwidthAllocation": { + "get": { + "description": "An account's associated virtual guest objects currently over bandwidth allocation.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuestsWithCpanel": { + "get": { + "description": "All virtual guests associated with an account that has the cPanel web hosting control panel installed.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuestsWithMcafee": { + "get": { + "description": "All virtual guests associated with an account that have McAfee Secure software components.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuestsWithMcafeeAntivirusRedhat": { + "get": { + "description": "All virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuestsWithMcafeeAntivirusWindows": { + "get": { + "description": "All virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuestsWithMcafeeIntrusionDetectionSystem": { + "get": { + "description": "All virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuestsWithPlesk": { + "get": { + "description": "All virtual guests associated with an account that has the Plesk web hosting control panel installed.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuestsWithQuantastor": { + "get": { + "description": "All virtual guests associated with an account that have the QuantaStor storage system installed.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualGuestsWithUrchin": { + "get": { + "description": "All virtual guests associated with an account that has the Urchin web traffic analytics package installed.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualPrivateRack": { + "get": { + "description": "The bandwidth pooling for this account.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualStorageArchiveRepositories": { + "get": { + "description": "An account's associated virtual server archived storage repositories.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVirtualStoragePublicRepositories": { + "get": { + "description": "An account's associated virtual server public storage repositories.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVpcVirtualGuests": { + "get": { + "description": "An account's associated VPC configured virtual guest objects.", + "summary": "", + "externalDocs": "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/{SoftLayer_AccountID}/getVpnConfigRequiresVPNManageFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Account_Address/getAllDataCenters": { + "get": { + "description": "Retrieve a list of SoftLayer datacenter addresses.", + "summary": "Retrieve a list of SoftLayer datacenter addresses.", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Address record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getAccount": { + "get": { + "description": "The account to which this address belongs.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getCreateUser": { + "get": { + "description": "The customer user who created this address.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getLocation": { + "get": { + "description": "The location of this address.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getModifyEmployee": { + "get": { + "description": "The employee who last modified this address.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getModifyUser": { + "get": { + "description": "The customer user who last modified this address.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Address/{SoftLayer_Account_AddressID}/getType": { + "get": { + "description": "An account address' type.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Address_Type/{SoftLayer_Account_Address_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Address_Type record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Affiliation/createObject": { + "post": { + "description": "Create a new affiliation to associate with an existing account. ", + "summary": "Create a new affiliation.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Affiliation/{SoftLayer_Account_AffiliationID}/deleteObject": { + "get": { + "description": "deleteObject permanently removes an account affiliation ", + "summary": "Delete an account affiliation", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Account_Affiliation/getAccountAffiliationsByAffiliateId": { + "post": { + "description": "Get account affiliation information associated with affiliate id. ", + "summary": "Get account affiliation information associated with affiliate id.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Affiliation/{SoftLayer_Account_AffiliationID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Affiliation record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Affiliation/{SoftLayer_Account_AffiliationID}/getAccount": { + "get": { + "description": "The account that an affiliation belongs to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Agreement record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getAgreementType": { + "get": { + "description": "The type of agreement.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getAttachedBillingAgreementFiles": { + "get": { + "description": "The files attached to an agreement.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getBillingItems": { + "get": { + "description": "The billing items associated with an agreement.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getStatus": { + "get": { + "description": "The status of the agreement.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Agreement/{SoftLayer_Account_AgreementID}/getTopLevelBillingItems": { + "get": { + "description": "The top level billing item associated with an agreement.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Authentication_Attribute/{SoftLayer_Account_Authentication_AttributeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Authentication_Attribute record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Authentication_Attribute/{SoftLayer_Account_Authentication_AttributeID}/getAccount": { + "get": { + "description": "The SoftLayer customer account.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Authentication_Attribute/{SoftLayer_Account_Authentication_AttributeID}/getAuthenticationRecord": { + "get": { + "description": "The SoftLayer account authentication that has an attribute.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Authentication_Attribute/{SoftLayer_Account_Authentication_AttributeID}/getType": { + "get": { + "description": "The type of attribute assigned to a SoftLayer account authentication.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Authentication_Attribute_Type/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Account_Authentication_Saml/createObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Authentication_Saml/{SoftLayer_Account_Authentication_SamlID}/deleteObject": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Account_Authentication_Saml/{SoftLayer_Account_Authentication_SamlID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Authentication_Saml record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Authentication_Saml/{SoftLayer_Account_Authentication_SamlID}/getAccount": { + "get": { + "description": "The account associated with this saml configuration.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Authentication_Saml/{SoftLayer_Account_Authentication_SamlID}/getAttributes": { + "get": { + "description": "The saml attribute values for a SoftLayer customer account.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Brand_Migration_Request/{SoftLayer_Account_Brand_Migration_RequestID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Brand_Migration_Request record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Brand_Migration_Request/{SoftLayer_Account_Brand_Migration_RequestID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Brand_Migration_Request/{SoftLayer_Account_Brand_Migration_RequestID}/getDestinationBrand": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Brand_Migration_Request/{SoftLayer_Account_Brand_Migration_RequestID}/getSourceBrand": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Brand_Migration_Request/{SoftLayer_Account_Brand_Migration_RequestID}/getUser": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Business_Partner/{SoftLayer_Account_Business_PartnerID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Business_Partner record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Business_Partner/{SoftLayer_Account_Business_PartnerID}/getAccount": { + "get": { + "description": "Account associated with the business partner data", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Business_Partner/{SoftLayer_Account_Business_PartnerID}/getChannel": { + "get": { + "description": "Channel indicator used to categorize business partner revenue.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Business_Partner/{SoftLayer_Account_Business_PartnerID}/getSegment": { + "get": { + "description": "Segment indicator used to categorize business partner revenue.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Account_Contact/createComplianceReportRequestorContact": { + "post": { + "description": "<.create_object > li > div { padding-top: .5em; padding-bottom: .5em} This method will create a new SoftLayer_Account_Regional_Registry_Detail object. \n\nInput - [[SoftLayer_Account_Regional_Registry_Detail (type)|SoftLayer_Account_Regional_Registry_Detail]] ", + "summary": "[Deprecated] Create a new detail object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/deleteObject": { + "get": { + "description": "The subnet registration detail service has been deprecated. \n\nThis method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. ", + "summary": "[Deprecated] Delete an existing detail object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/editObject": { + "post": { + "description": "The subnet registration detail service has been deprecated. \n\nThis method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see [[SoftLayer_Account_Regional_Registry_Detail::createObject|createObject]]. ", + "summary": "[Deprecated] Edit an existing detail object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Regional_Registry_Detail record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/getObject/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/updateReferencedRegistrations": { + "get": { + "description": "The subnet registration detail service has been deprecated. \n\nThis method will create a bulk transaction to update any registrations that reference this detail object. It should only be called from a child class such as [[SoftLayer_Account_Regional_Registry_Detail_Person]] or [[SoftLayer_Account_Regional_Registry_Detail_Network]]. The registrations should be in the Open or Registration_Complete status. ", + "summary": "[Deprecated] Create a transaction to update the registrations that reference this detail object.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::updateReferencedRegistrations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Subnet_Registration_TransactionDetails" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/validatePersonForAllRegistrars": { + "get": { + "description": "The subnet registration detail service has been deprecated. \n\nValidates this person detail against all supported external registrars (APNIC/ARIN/RIPE). The validation uses the most restrictive rules ensuring that any person detail passing this validation would be acceptable to any supported registrar. \n\nThe person detail properties are validated against - Non-emptiness - Minimum length - Maximum length - Maximum words - Supported characters - Format of data \n\nIf the person detail validation succeeds, then an empty list is returned indicating no errors were found and that this person detail would work against all three registrars during a subnet registration. \n\nIf the person detail validation fails, then an array of validation errors (SoftLayer_Container_Message[]) is returned. Each message container contains error messages grouped by property type and a message type indicating the person detail property type object which failed validation. It is possible to create a subnet registration using a person detail which does not pass this validation, but at least one registrar would reject it for being invalid. ", + "summary": "[Deprecated] Validate an existing person detail object.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::validatePersonForAllRegistrars", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Message" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getAccount": { + "get": { + "description": "[Deprecated] The account that this detail object belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getDetailType": { + "get": { + "description": "[Deprecated] The associated type of this detail object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::getDetailType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getDetails": { + "get": { + "description": "[Deprecated] References to the [[SoftLayer_Network_Subnet_Registration|registration objects]] that consume this detail object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::getDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration_Details" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getProperties": { + "get": { + "description": "[Deprecated] The individual properties that define this detail object's values.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::getProperties", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail_Property" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getRegionalInternetRegistryHandle": { + "get": { + "description": "[Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail::getRegionalInternetRegistryHandle", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Rwhois_Handle" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Property/createObject": { + "post": { + "description": "The subnet registration detail property service has been deprecated. \n\n This method will create a new SoftLayer_Account_Regional_Registry_Detail_Property object. \n\nInput - [[SoftLayer_Account_Regional_Registry_Detail_Property (type)|SoftLayer_Account_Regional_Registry_Detail_Property]] ", + "summary": "[Deprecated] Create a new property object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Property::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail_Property" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Property/createObjects": { + "post": { + "description": "The subnet registration detail property service has been deprecated. \n\nEdit multiple [[SoftLayer_Account_Regional_Registry_Detail_Property]] objects. ", + "summary": "[Deprecated] Create multiple property objects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Property::createObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail_Property" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Property/{SoftLayer_Account_Regional_Registry_Detail_PropertyID}/deleteObject": { + "get": { + "description": "The subnet registration detail property service has been deprecated. \n\nThis method will delete an existing SoftLayer_Account_Regional_Registry_Detail_Property object. ", + "summary": "[Deprecated] Delete an existing property object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Property::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Property/{SoftLayer_Account_Regional_Registry_Detail_PropertyID}/editObject": { + "post": { + "description": "The subnet registration detail property service has been deprecated. \n\nThis method will edit an existing SoftLayer_Account_Regional_Registry_Detail_Property object. For more detail, see [[SoftLayer_Account_Regional_Registry_Detail_Property::createObject|createObject]]. ", + "summary": "[Deprecated] Edit an existing property object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Property::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Property/editObjects": { + "post": { + "description": "The subnet registration detail property service has been deprecated. \n\nEdit multiple [[SoftLayer_Account_Regional_Registry_Detail_Property]] objects. ", + "summary": "[Deprecated] Edit multiple property objects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Property::editObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Property/{SoftLayer_Account_Regional_Registry_Detail_PropertyID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getObject/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Property::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail_Property" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Property/{SoftLayer_Account_Regional_Registry_Detail_PropertyID}/getDetail": { + "get": { + "description": "[Deprecated] The [[SoftLayer_Account_Regional_Registry_Detail]] object this property belongs to", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Property::getDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Property/{SoftLayer_Account_Regional_Registry_Detail_PropertyID}/getPropertyType": { + "get": { + "description": "[Deprecated] The [[SoftLayer_Account_Regional_Registry_Detail_Property_Type]] object this property belongs to", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Property::getPropertyType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail_Property_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Property_Type::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail_Property_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Property_Type/{SoftLayer_Account_Regional_Registry_Detail_Property_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getObject/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Property_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail_Property_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Type::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Regional_Registry_Detail_Type/{SoftLayer_Account_Regional_Registry_Detail_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Regional_Registry_Detail_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getObject/", + "operationId": "SoftLayer_Account_Regional_Registry_Detail_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/createRequest": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/createRequest/", + "operationId": "SoftLayer_Account_Reports_Request::createRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Reports_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/getAllObjects/", + "operationId": "SoftLayer_Account_Reports_Request::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Reports_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/{SoftLayer_Account_Reports_RequestID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Reports_Request record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/getObject/", + "operationId": "SoftLayer_Account_Reports_Request::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Reports_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/getRequestByRequestKey": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/getRequestByRequestKey/", + "operationId": "SoftLayer_Account_Reports_Request::getRequestByRequestKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Reports_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/sendReportEmail": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/sendReportEmail/", + "operationId": "SoftLayer_Account_Reports_Request::sendReportEmail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/updateTicketOnDecline": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/updateTicketOnDecline/", + "operationId": "SoftLayer_Account_Reports_Request::updateTicketOnDecline", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/{SoftLayer_Account_Reports_RequestID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/getAccount/", + "operationId": "SoftLayer_Account_Reports_Request::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/{SoftLayer_Account_Reports_RequestID}/getAccountContact": { + "get": { + "description": "A request's corresponding external contact, if one exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/getAccountContact/", + "operationId": "SoftLayer_Account_Reports_Request::getAccountContact", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Contact" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/{SoftLayer_Account_Reports_RequestID}/getReportType": { + "get": { + "description": "Type of the report customer is requesting for.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/getReportType/", + "operationId": "SoftLayer_Account_Reports_Request::getReportType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Compliance_Report_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/{SoftLayer_Account_Reports_RequestID}/getRequestorContact": { + "get": { + "description": "A request's corresponding requestor contact, if one exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/getRequestorContact/", + "operationId": "SoftLayer_Account_Reports_Request::getRequestorContact", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Contact" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/{SoftLayer_Account_Reports_RequestID}/getTicket": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/getTicket/", + "operationId": "SoftLayer_Account_Reports_Request::getTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Reports_Request/{SoftLayer_Account_Reports_RequestID}/getUser": { + "get": { + "description": "The customer user that initiated a report request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Reports_Request/getUser/", + "operationId": "SoftLayer_Account_Reports_Request::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/editObject": { + "post": { + "description": "Edit the properties of a shipment record by passing in a modified instance of a SoftLayer_Account_Shipment object. ", + "summary": "Edit a shipment record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/editObject/", + "operationId": "SoftLayer_Account_Shipment::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/getAllCouriers": { + "get": { + "description": "Retrieve a list of available shipping couriers.", + "summary": "Retrieve a list of available shipping couriers.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getAllCouriers/", + "operationId": "SoftLayer_Account_Shipment::getAllCouriers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Shipping_Courier" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/getAllCouriersByType": { + "post": { + "description": "Retrieve a list of available shipping couriers.", + "summary": "Retrieve a list of couriers for a given courier type", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getAllCouriersByType/", + "operationId": "SoftLayer_Account_Shipment::getAllCouriersByType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Shipping_Courier" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/getAllShipmentStatuses": { + "get": { + "description": "Retrieve a a list of shipment statuses.", + "summary": "Retrieve a list of shipment statuses.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getAllShipmentStatuses/", + "operationId": "SoftLayer_Account_Shipment::getAllShipmentStatuses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Status" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/getAllShipmentTypes": { + "get": { + "description": "Retrieve a a list of shipment types.", + "summary": "Retrieve a list of shipment types.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getAllShipmentTypes/", + "operationId": "SoftLayer_Account_Shipment::getAllShipmentTypes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Shipment record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getObject/", + "operationId": "SoftLayer_Account_Shipment::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getAccount": { + "get": { + "description": "The account to which the shipment belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getAccount/", + "operationId": "SoftLayer_Account_Shipment::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getCourier": { + "get": { + "description": "The courier handling the shipment.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getCourier/", + "operationId": "SoftLayer_Account_Shipment::getCourier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Shipping_Courier" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getCreateEmployee": { + "get": { + "description": "The employee who created the shipment.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getCreateEmployee/", + "operationId": "SoftLayer_Account_Shipment::getCreateEmployee", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Employee" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getCreateUser": { + "get": { + "description": "The customer user who created the shipment.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getCreateUser/", + "operationId": "SoftLayer_Account_Shipment::getCreateUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getCurrency": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getCurrency/", + "operationId": "SoftLayer_Account_Shipment::getCurrency", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getDestinationAddress": { + "get": { + "description": "The address at which the shipment is received.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getDestinationAddress/", + "operationId": "SoftLayer_Account_Shipment::getDestinationAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getMasterTrackingData": { + "get": { + "description": "The one master tracking data for the shipment.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getMasterTrackingData/", + "operationId": "SoftLayer_Account_Shipment::getMasterTrackingData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Tracking_Data" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getModifyEmployee": { + "get": { + "description": "The employee who last modified the shipment.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getModifyEmployee/", + "operationId": "SoftLayer_Account_Shipment::getModifyEmployee", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Employee" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getModifyUser": { + "get": { + "description": "The customer user who last modified the shipment.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getModifyUser/", + "operationId": "SoftLayer_Account_Shipment::getModifyUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getOriginationAddress": { + "get": { + "description": "The address from which the shipment is sent.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getOriginationAddress/", + "operationId": "SoftLayer_Account_Shipment::getOriginationAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getShipmentItems": { + "get": { + "description": "The items in the shipment.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getShipmentItems/", + "operationId": "SoftLayer_Account_Shipment::getShipmentItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getStatus": { + "get": { + "description": "The status of the shipment.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getStatus/", + "operationId": "SoftLayer_Account_Shipment::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getTrackingData": { + "get": { + "description": "All tracking data for the shipment and packages.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getTrackingData/", + "operationId": "SoftLayer_Account_Shipment::getTrackingData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Tracking_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getType": { + "get": { + "description": "The type of shipment (e.g. for Data Transfer Service or Colocation Service).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getType/", + "operationId": "SoftLayer_Account_Shipment::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment/{SoftLayer_Account_ShipmentID}/getViaAddress": { + "get": { + "description": "The address at which the shipment is received.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment/getViaAddress/", + "operationId": "SoftLayer_Account_Shipment::getViaAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Item/{SoftLayer_Account_Shipment_ItemID}/editObject": { + "post": { + "description": "Edit the properties of a shipment record by passing in a modified instance of a SoftLayer_Account_Shipment_Item object. ", + "summary": "Edit a shipment record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Item/editObject/", + "operationId": "SoftLayer_Account_Shipment_Item::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Item/{SoftLayer_Account_Shipment_ItemID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Shipment_Item record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Item/getObject/", + "operationId": "SoftLayer_Account_Shipment_Item::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Item/{SoftLayer_Account_Shipment_ItemID}/getShipment": { + "get": { + "description": "The shipment to which this item belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Item/getShipment/", + "operationId": "SoftLayer_Account_Shipment_Item::getShipment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Item/{SoftLayer_Account_Shipment_ItemID}/getShipmentItemType": { + "get": { + "description": "The type of this shipment item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Item/getShipmentItemType/", + "operationId": "SoftLayer_Account_Shipment_Item::getShipmentItemType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Item_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Item_Type/{SoftLayer_Account_Shipment_Item_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Shipment_Item_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Item_Type/getObject/", + "operationId": "SoftLayer_Account_Shipment_Item_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Item_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Resource_Type/{SoftLayer_Account_Shipment_Resource_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Shipment_Resource_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Resource_Type/getObject/", + "operationId": "SoftLayer_Account_Shipment_Resource_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Resource_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Status/{SoftLayer_Account_Shipment_StatusID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Shipment_Status record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Status/getObject/", + "operationId": "SoftLayer_Account_Shipment_Status::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Tracking_Data/createObject": { + "post": { + "description": "Create a new shipment tracking data. The ''shipmentId'', ''sequence'', and ''trackingData'' properties in the templateObject parameter are required parameters to create a tracking data record. ", + "summary": "Create a new shipment tracking data.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObject/", + "operationId": "SoftLayer_Account_Shipment_Tracking_Data::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Tracking_Data" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Tracking_Data/createObjects": { + "post": { + "description": "Create a new shipment tracking data. The ''shipmentId'', ''sequence'', and ''trackingData'' properties of each templateObject in the templateObjects array are required parameters to create a tracking data record. ", + "summary": "Create multiple tracking data records.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObjects/", + "operationId": "SoftLayer_Account_Shipment_Tracking_Data::createObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Tracking_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Tracking_Data/{SoftLayer_Account_Shipment_Tracking_DataID}/deleteObject": { + "get": { + "description": "deleteObject permanently removes a shipment tracking datum (number) ", + "summary": "Delete a shipment tracking datum (number)", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Tracking_Data/deleteObject/", + "operationId": "SoftLayer_Account_Shipment_Tracking_Data::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Tracking_Data/{SoftLayer_Account_Shipment_Tracking_DataID}/editObject": { + "post": { + "description": "Edit the properties of a tracking data record by passing in a modified instance of a SoftLayer_Account_Shipment_Tracking_Data object. ", + "summary": "Edit a tracking data.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Tracking_Data/editObject/", + "operationId": "SoftLayer_Account_Shipment_Tracking_Data::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Tracking_Data/{SoftLayer_Account_Shipment_Tracking_DataID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Shipment_Tracking_Data record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getObject/", + "operationId": "SoftLayer_Account_Shipment_Tracking_Data::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Tracking_Data" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Tracking_Data/{SoftLayer_Account_Shipment_Tracking_DataID}/getCreateEmployee": { + "get": { + "description": "The employee who created the tracking datum.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateEmployee/", + "operationId": "SoftLayer_Account_Shipment_Tracking_Data::getCreateEmployee", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Employee" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Tracking_Data/{SoftLayer_Account_Shipment_Tracking_DataID}/getCreateUser": { + "get": { + "description": "The customer user who created the tracking datum.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateUser/", + "operationId": "SoftLayer_Account_Shipment_Tracking_Data::getCreateUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Tracking_Data/{SoftLayer_Account_Shipment_Tracking_DataID}/getModifyEmployee": { + "get": { + "description": "The employee who last modified the tracking datum.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyEmployee/", + "operationId": "SoftLayer_Account_Shipment_Tracking_Data::getModifyEmployee", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Employee" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Tracking_Data/{SoftLayer_Account_Shipment_Tracking_DataID}/getModifyUser": { + "get": { + "description": "The customer user who last modified the tracking datum.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyUser/", + "operationId": "SoftLayer_Account_Shipment_Tracking_Data::getModifyUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Tracking_Data/{SoftLayer_Account_Shipment_Tracking_DataID}/getShipment": { + "get": { + "description": "The shipment of the tracking datum.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getShipment/", + "operationId": "SoftLayer_Account_Shipment_Tracking_Data::getShipment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Shipment_Type/{SoftLayer_Account_Shipment_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Shipment_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Shipment_Type/getObject/", + "operationId": "SoftLayer_Account_Shipment_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Status_Change_Reason/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Status_Change_Reason/getAllObjects/", + "operationId": "SoftLayer_Account_Status_Change_Reason::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Status_Change_Reason" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Account_Status_Change_Reason/{SoftLayer_Account_Status_Change_ReasonID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Account_Status_Change_Reason record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Account_Status_Change_Reason/getObject/", + "operationId": "SoftLayer_Account_Status_Change_Reason::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Status_Change_Reason" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Auxiliary_Network_Status/getNetworkStatus": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Auxiliary_Network_Status/getNetworkStatus/", + "operationId": "SoftLayer_Auxiliary_Network_Status::getNetworkStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Auxiliary_Network_Status_Reading" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Auxiliary_Notification_Emergency/getAllObjects": { + "get": { + "description": "Retrieve an array of SoftLayer_Auxiliary_Notification_Emergency data types, which contain all notification events regardless of status. ", + "summary": "Retrieve all notification events.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getAllObjects/", + "operationId": "SoftLayer_Auxiliary_Notification_Emergency::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Notification_Emergency" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Auxiliary_Notification_Emergency/getCurrentNotifications": { + "get": { + "description": "Retrieve an array of SoftLayer_Auxiliary_Notification_Emergency data types, which contain all current notification events. ", + "summary": "Retrieve current notification events.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getCurrentNotifications/", + "operationId": "SoftLayer_Auxiliary_Notification_Emergency::getCurrentNotifications", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Notification_Emergency" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Auxiliary_Notification_Emergency/{SoftLayer_Auxiliary_Notification_EmergencyID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Auxiliary_Notification_Emergency object, it can be used to check for current notifications being broadcast by SoftLayer. ", + "summary": "Retrieve a SoftLayer_Auxiliary_Notification_Emergency record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getObject/", + "operationId": "SoftLayer_Auxiliary_Notification_Emergency::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Notification_Emergency" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Auxiliary_Notification_Emergency/{SoftLayer_Auxiliary_Notification_EmergencyID}/getSignature": { + "get": { + "description": "The signature of the SoftLayer employee department associated with this notification.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getSignature/", + "operationId": "SoftLayer_Auxiliary_Notification_Emergency::getSignature", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Notification_Emergency_Signature" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Auxiliary_Notification_Emergency/{SoftLayer_Auxiliary_Notification_EmergencyID}/getStatus": { + "get": { + "description": "The status of this notification.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getStatus/", + "operationId": "SoftLayer_Auxiliary_Notification_Emergency::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Notification_Emergency_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Auxiliary_Shipping_Courier_Type/{SoftLayer_Auxiliary_Shipping_Courier_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Auxiliary_Shipping_Courier_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getObject/", + "operationId": "SoftLayer_Auxiliary_Shipping_Courier_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Shipping_Courier_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Auxiliary_Shipping_Courier_Type/getTypeByKeyName": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getTypeByKeyName/", + "operationId": "SoftLayer_Auxiliary_Shipping_Courier_Type::getTypeByKeyName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Shipping_Courier_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Auxiliary_Shipping_Courier_Type/{SoftLayer_Auxiliary_Shipping_Courier_TypeID}/getCourier": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getCourier/", + "operationId": "SoftLayer_Auxiliary_Shipping_Courier_Type::getCourier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Auxiliary_Shipping_Courier" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency/getAllObjects/", + "operationId": "SoftLayer_Billing_Currency::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency/{SoftLayer_Billing_CurrencyID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Billing_Currency record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency/getObject/", + "operationId": "SoftLayer_Billing_Currency::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency/{SoftLayer_Billing_CurrencyID}/getPrice": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency/getPrice/", + "operationId": "SoftLayer_Billing_Currency::getPrice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency/{SoftLayer_Billing_CurrencyID}/getCurrentExchangeRate": { + "get": { + "description": "The current exchange rate", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency/getCurrentExchangeRate/", + "operationId": "SoftLayer_Billing_Currency::getCurrentExchangeRate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency_ExchangeRate" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency_Country/getCountriesWithListOfEligibleCurrencies": { + "get": { + "description": null, + "summary": "Get map between countries and what currencies can be supported for customers in that country. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency_Country/getCountriesWithListOfEligibleCurrencies/", + "operationId": "SoftLayer_Billing_Currency_Country::getCountriesWithListOfEligibleCurrencies", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Billing_Currency_Country" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency_Country/{SoftLayer_Billing_Currency_CountryID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Billing_Currency_Country record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency_Country/getObject/", + "operationId": "SoftLayer_Billing_Currency_Country::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency_Country" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency_ExchangeRate/{SoftLayer_Billing_Currency_ExchangeRateID}/getAllCurrencyExchangeRates": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getAllCurrencyExchangeRates/", + "operationId": "SoftLayer_Billing_Currency_ExchangeRate::getAllCurrencyExchangeRates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency_ExchangeRate" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency_ExchangeRate/getCurrencies": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getCurrencies/", + "operationId": "SoftLayer_Billing_Currency_ExchangeRate::getCurrencies", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency_ExchangeRate/getExchangeRate": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getExchangeRate/", + "operationId": "SoftLayer_Billing_Currency_ExchangeRate::getExchangeRate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency_ExchangeRate" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency_ExchangeRate/{SoftLayer_Billing_Currency_ExchangeRateID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Billing_Currency_ExchangeRate record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getObject/", + "operationId": "SoftLayer_Billing_Currency_ExchangeRate::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency_ExchangeRate" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency_ExchangeRate/{SoftLayer_Billing_Currency_ExchangeRateID}/getPrice": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getPrice/", + "operationId": "SoftLayer_Billing_Currency_ExchangeRate::getPrice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency_ExchangeRate/{SoftLayer_Billing_Currency_ExchangeRateID}/getFundingCurrency": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getFundingCurrency/", + "operationId": "SoftLayer_Billing_Currency_ExchangeRate::getFundingCurrency", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Currency_ExchangeRate/{SoftLayer_Billing_Currency_ExchangeRateID}/getLocalCurrency": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getLocalCurrency/", + "operationId": "SoftLayer_Billing_Currency_ExchangeRate::getLocalCurrency", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Info/{SoftLayer_Billing_InfoID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Billing_Info object whose data corresponds to the account to which your portal user is tied. ", + "summary": "Retrieve a SoftLayer_Billing_Info record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Info/getObject/", + "operationId": "SoftLayer_Billing_Info::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Info" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Info/{SoftLayer_Billing_InfoID}/getAccount": { + "get": { + "description": "The SoftLayer customer account associated with this billing information.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Info/getAccount/", + "operationId": "SoftLayer_Billing_Info::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Info/{SoftLayer_Billing_InfoID}/getAchInformation": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Info/getAchInformation/", + "operationId": "SoftLayer_Billing_Info::getAchInformation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Info_Ach" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Info/{SoftLayer_Billing_InfoID}/getCurrency": { + "get": { + "description": "Currency to be used by this customer account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Info/getCurrency/", + "operationId": "SoftLayer_Billing_Info::getCurrency", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Info/{SoftLayer_Billing_InfoID}/getCurrentBillingCycle": { + "get": { + "description": "Information related to an account's current and previous billing cycles.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Info/getCurrentBillingCycle/", + "operationId": "SoftLayer_Billing_Info::getCurrentBillingCycle", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Info_Cycle" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Info/{SoftLayer_Billing_InfoID}/getLastBillDate": { + "get": { + "description": "The date on which an account was last billed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Info/getLastBillDate/", + "operationId": "SoftLayer_Billing_Info::getLastBillDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Info/{SoftLayer_Billing_InfoID}/getNextBillDate": { + "get": { + "description": "The date on which an account will be billed next.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Info/getNextBillDate/", + "operationId": "SoftLayer_Billing_Info::getNextBillDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/emailInvoices": { + "post": { + "description": "Create a transaction to email PDF and/or Excel invoice links to the requesting user's email address. You must have a PDF reader installed in order to view these files. ", + "summary": "Create a transaction to email invoice links.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/emailInvoices/", + "operationId": "SoftLayer_Billing_Invoice::emailInvoices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getExcel": { + "get": { + "description": "Retrieve a Microsoft Excel spreadsheet of a SoftLayer invoice. You must have a Microsoft Excel reader installed in order to view these invoice files. ", + "summary": "Retrieve a Microsoft Excel copy of an invoice.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getExcel/", + "operationId": "SoftLayer_Billing_Invoice::getExcel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Billing_Invoice object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Invoice service. You can only retrieve invoices that are assigned to your portal user's account. ", + "summary": "Retrieve a SoftLayer_Billing_Invoice record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getObject/", + "operationId": "SoftLayer_Billing_Invoice::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getPdf": { + "get": { + "description": "Retrieve a PDF record of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these invoice files. ", + "summary": "Retrieve a PDF copy of an invoice.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getPdf/", + "operationId": "SoftLayer_Billing_Invoice::getPdf", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getPdfDetailed": { + "get": { + "description": "Retrieve a PDF record of a SoftLayer detailed invoice summary. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these files. ", + "summary": "Retrieve a PDF copy of the detailed invoice summary.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getPdfDetailed/", + "operationId": "SoftLayer_Billing_Invoice::getPdfDetailed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getPdfDetailedFilename": { + "get": { + "description": null, + "summary": "Get the name of the detailed version of the PDF.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getPdfDetailedFilename/", + "operationId": "SoftLayer_Billing_Invoice::getPdfDetailedFilename", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getPdfFileSize": { + "get": { + "description": "Retrieve the size of a PDF record of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. ", + "summary": "Retrieve the size of a PDF copy of an invoice.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getPdfFileSize/", + "operationId": "SoftLayer_Billing_Invoice::getPdfFileSize", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getPdfFilename": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getPdfFilename/", + "operationId": "SoftLayer_Billing_Invoice::getPdfFilename", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getPreliminaryExcel": { + "get": { + "description": "Retrieve a Microsoft Excel record of a SoftLayer invoice. SoftLayer generates Microsoft Excel records of all closed invoices for customer retrieval from the portal and API. You must have a Microsoft Excel reader installed in order to view these invoice files. ", + "summary": "Retrieve a Microsoft Excel copy of an invoice.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getPreliminaryExcel/", + "operationId": "SoftLayer_Billing_Invoice::getPreliminaryExcel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getPreliminaryPdf": { + "get": { + "description": "Retrieve a PDF record of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these invoice files. ", + "summary": "Retrieve a PDF copy of an invoice.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdf/", + "operationId": "SoftLayer_Billing_Invoice::getPreliminaryPdf", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getPreliminaryPdfDetailed": { + "get": { + "description": "Retrieve a PDF record of the detailed version of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. ", + "summary": "Retrieve a PDF copy of the detailed version of an invoice.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdfDetailed/", + "operationId": "SoftLayer_Billing_Invoice::getPreliminaryPdfDetailed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getXlsFilename": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getXlsFilename/", + "operationId": "SoftLayer_Billing_Invoice::getXlsFilename", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getZeroFeeItemCounts": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getZeroFeeItemCounts/", + "operationId": "SoftLayer_Billing_Invoice::getZeroFeeItemCounts", + "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_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getAccount": { + "get": { + "description": "The account that an invoice belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getAccount/", + "operationId": "SoftLayer_Billing_Invoice::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getAmount": { + "get": { + "description": "This is the amount of this invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getAmount/", + "operationId": "SoftLayer_Billing_Invoice::getAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getBrandAtInvoiceCreation": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getBrandAtInvoiceCreation/", + "operationId": "SoftLayer_Billing_Invoice::getBrandAtInvoiceCreation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getChargebackType": { + "get": { + "description": "Chargeback type for invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getChargebackType/", + "operationId": "SoftLayer_Billing_Invoice::getChargebackType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Chargeback_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getDetailedPdfGeneratedFlag": { + "get": { + "description": "A flag that will reflect whether the detailed version of the pdf has been generated.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getDetailedPdfGeneratedFlag/", + "operationId": "SoftLayer_Billing_Invoice::getDetailedPdfGeneratedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getInvoiceTopLevelItems": { + "get": { + "description": "A list of top-level invoice items that are on the currently pending invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getInvoiceTopLevelItems/", + "operationId": "SoftLayer_Billing_Invoice::getInvoiceTopLevelItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getInvoiceTotalAmount": { + "get": { + "description": "The total amount of this invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalAmount/", + "operationId": "SoftLayer_Billing_Invoice::getInvoiceTotalAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getInvoiceTotalOneTimeAmount": { + "get": { + "description": "The total one-time charges for this invoice. This is the sum of one-time charges + setup fees + labor fees. This does not include taxes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeAmount/", + "operationId": "SoftLayer_Billing_Invoice::getInvoiceTotalOneTimeAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getInvoiceTotalOneTimeTaxAmount": { + "get": { + "description": "A sum of all the taxes related to one time charges for this invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeTaxAmount/", + "operationId": "SoftLayer_Billing_Invoice::getInvoiceTotalOneTimeTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getInvoiceTotalPreTaxAmount": { + "get": { + "description": "The total amount of this invoice. This does not include taxes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalPreTaxAmount/", + "operationId": "SoftLayer_Billing_Invoice::getInvoiceTotalPreTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getInvoiceTotalRecurringAmount": { + "get": { + "description": "The total Recurring amount of this invoice. This amount does not include taxes or one time charges.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringAmount/", + "operationId": "SoftLayer_Billing_Invoice::getInvoiceTotalRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getInvoiceTotalRecurringTaxAmount": { + "get": { + "description": "The total amount of the recurring taxes on this invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringTaxAmount/", + "operationId": "SoftLayer_Billing_Invoice::getInvoiceTotalRecurringTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getItems": { + "get": { + "description": "The items that belong to this invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getItems/", + "operationId": "SoftLayer_Billing_Invoice::getItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getLocalCurrencyExchangeRate": { + "get": { + "description": "Exchange rate used for billing this invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getLocalCurrencyExchangeRate/", + "operationId": "SoftLayer_Billing_Invoice::getLocalCurrencyExchangeRate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency_ExchangeRate" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getPayment": { + "get": { + "description": "This is the total payment made on this invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getPayment/", + "operationId": "SoftLayer_Billing_Invoice::getPayment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getPayments": { + "get": { + "description": "The payments for the invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getPayments/", + "operationId": "SoftLayer_Billing_Invoice::getPayments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Receivable_Payment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getSellerRegistration": { + "get": { + "description": "This is the seller's tax registration.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getSellerRegistration/", + "operationId": "SoftLayer_Billing_Invoice::getSellerRegistration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getTaxInfo": { + "get": { + "description": "This is the tax information that applies to tax auditing. This is the official tax record for this invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getTaxInfo/", + "operationId": "SoftLayer_Billing_Invoice::getTaxInfo", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Tax_Info" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getTaxInfoHistory": { + "get": { + "description": "This is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getTaxInfoHistory/", + "operationId": "SoftLayer_Billing_Invoice::getTaxInfoHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Tax_Info" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getTaxMessage": { + "get": { + "description": "This is a message explaining the tax treatment for this invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getTaxMessage/", + "operationId": "SoftLayer_Billing_Invoice::getTaxMessage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice/{SoftLayer_Billing_InvoiceID}/getTaxType": { + "get": { + "description": "This is the strategy used to calculate tax on this invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice/getTaxType/", + "operationId": "SoftLayer_Billing_Invoice::getTaxType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Tax_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Billing_Invoice_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Invoice_Item service. You can only retrieve the items tied to the account that your portal user is assigned to. ", + "summary": "Retrieve a SoftLayer_Billing_Invoice_Item record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getObject/", + "operationId": "SoftLayer_Billing_Invoice_Item::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getAssociatedChildren": { + "get": { + "description": "An Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedChildren/", + "operationId": "SoftLayer_Billing_Invoice_Item::getAssociatedChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getAssociatedInvoiceItem": { + "get": { + "description": "An Invoice Item's associated invoice item. If this is populated, it means this is an orphaned invoice item, but logically belongs to the associated invoice item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedInvoiceItem/", + "operationId": "SoftLayer_Billing_Invoice_Item::getAssociatedInvoiceItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getBillingItem": { + "get": { + "description": "An Invoice Item's billing item, from which this item was generated.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getBillingItem/", + "operationId": "SoftLayer_Billing_Invoice_Item::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getCategory": { + "get": { + "description": "This invoice item's \"item category\". ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getCategory/", + "operationId": "SoftLayer_Billing_Invoice_Item::getCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getChildren": { + "get": { + "description": "An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getChildren/", + "operationId": "SoftLayer_Billing_Invoice_Item::getChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getDPart": { + "get": { + "description": "This is the DPart for invoice item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getDPart/", + "operationId": "SoftLayer_Billing_Invoice_Item::getDPart", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getDiscountingInvoiceItemId": { + "get": { + "description": "The invoice item ID from which the discount is derived.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getDiscountingInvoiceItemId/", + "operationId": "SoftLayer_Billing_Invoice_Item::getDiscountingInvoiceItemId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getFilteredAssociatedChildren": { + "get": { + "description": "An Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getFilteredAssociatedChildren/", + "operationId": "SoftLayer_Billing_Invoice_Item::getFilteredAssociatedChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getHourlyFlag": { + "get": { + "description": "Indicating whether this invoice item is billed on an hourly basis.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getHourlyFlag/", + "operationId": "SoftLayer_Billing_Invoice_Item::getHourlyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getInvoice": { + "get": { + "description": "The invoice to which this item belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getInvoice/", + "operationId": "SoftLayer_Billing_Invoice_Item::getInvoice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getLocation": { + "get": { + "description": "An invoice item's location, if one exists.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getLocation/", + "operationId": "SoftLayer_Billing_Invoice_Item::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getNonZeroAssociatedChildren": { + "get": { + "description": "An Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getNonZeroAssociatedChildren/", + "operationId": "SoftLayer_Billing_Invoice_Item::getNonZeroAssociatedChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getParent": { + "get": { + "description": "Every item tied to a server should have a parent invoice item which is the server line item. This is how we associate items to a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getParent/", + "operationId": "SoftLayer_Billing_Invoice_Item::getParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getProduct": { + "get": { + "description": "The entry in the product catalog that a invoice item is based upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getProduct/", + "operationId": "SoftLayer_Billing_Invoice_Item::getProduct", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getTopLevelProductGroupName": { + "get": { + "description": "A string representing the name of parent level product group of an invoice item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getTopLevelProductGroupName/", + "operationId": "SoftLayer_Billing_Invoice_Item::getTopLevelProductGroupName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getTotalOneTimeAmount": { + "get": { + "description": "An invoice Item's total, including any child invoice items if they exist.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeAmount/", + "operationId": "SoftLayer_Billing_Invoice_Item::getTotalOneTimeAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getTotalOneTimeTaxAmount": { + "get": { + "description": "An invoice Item's total, including any child invoice items if they exist.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeTaxAmount/", + "operationId": "SoftLayer_Billing_Invoice_Item::getTotalOneTimeTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getTotalRecurringAmount": { + "get": { + "description": "An invoice Item's total, including any child invoice items if they exist.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringAmount/", + "operationId": "SoftLayer_Billing_Invoice_Item::getTotalRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getTotalRecurringTaxAmount": { + "get": { + "description": "A Billing Item's total, including any child billing items if they exist.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringTaxAmount/", + "operationId": "SoftLayer_Billing_Invoice_Item::getTotalRecurringTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Item/{SoftLayer_Billing_Invoice_ItemID}/getUsageChargeFlag": { + "get": { + "description": "Indicating whether this invoice item is for the usage charge.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Item/getUsageChargeFlag/", + "operationId": "SoftLayer_Billing_Invoice_Item::getUsageChargeFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Next/{SoftLayer_Billing_Invoice_NextID}/getExcel": { + "post": { + "description": "Return an account's next invoice in a Microsoft excel format.", + "summary": "Retrieve the next billing period's invoice as an Excel.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Next/getExcel/", + "operationId": "SoftLayer_Billing_Invoice_Next::getExcel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Next/{SoftLayer_Billing_Invoice_NextID}/getPdf": { + "post": { + "description": "Return an account's next invoice in PDF format.", + "summary": "Retrieve the next billing period's invoice as a PDF.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Next/getPdf/", + "operationId": "SoftLayer_Billing_Invoice_Next::getPdf", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Next/{SoftLayer_Billing_Invoice_NextID}/getPdfDetailed": { + "post": { + "description": "Return an account's next invoice detailed portion in PDF format.", + "summary": "Retrieve the next billing period's detailed invoice as a PDF.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Next/getPdfDetailed/", + "operationId": "SoftLayer_Billing_Invoice_Next::getPdfDetailed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Tax_Status/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getAllObjects/", + "operationId": "SoftLayer_Billing_Invoice_Tax_Status::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Tax_Status" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Tax_Status/{SoftLayer_Billing_Invoice_Tax_StatusID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Billing_Invoice_Tax_Status record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getObject/", + "operationId": "SoftLayer_Billing_Invoice_Tax_Status::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Tax_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Tax_Type/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getAllObjects/", + "operationId": "SoftLayer_Billing_Invoice_Tax_Type::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Tax_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Invoice_Tax_Type/{SoftLayer_Billing_Invoice_Tax_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Billing_Invoice_Tax_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getObject/", + "operationId": "SoftLayer_Billing_Invoice_Tax_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Tax_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/cancelItem": { + "post": { + "description": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "summary": "Cancel a service or resource.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/cancelItem/", + "operationId": "SoftLayer_Billing_Item::cancelItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/cancelService": { + "get": { + "description": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "summary": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/cancelService/", + "operationId": "SoftLayer_Billing_Item::cancelService", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/cancelServiceOnAnniversaryDate": { + "get": { + "description": "Cancel the resource or service for a billing Item ", + "summary": "Cancel a service or resource on the next bill date", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/cancelServiceOnAnniversaryDate/", + "operationId": "SoftLayer_Billing_Item::cancelServiceOnAnniversaryDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "summary": "Retrieve a SoftLayer_Billing_Item record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getObject/", + "operationId": "SoftLayer_Billing_Item::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/getServiceBillingItemsByCategory": { + "post": { + "description": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [[SoftLayer_Security_Certificate_Request|service cancellation]] service. \n\nIn order to find billing items for cancellation, use [[SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories|product categories]] service to retrieve category codes that are eligible for cancellation. ", + "summary": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getServiceBillingItemsByCategory/", + "operationId": "SoftLayer_Billing_Item::getServiceBillingItemsByCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/removeAssociationId": { + "get": { + "description": "Remove the association from a billing item. ", + "summary": "Remove an association from an orphan billing item.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/removeAssociationId/", + "operationId": "SoftLayer_Billing_Item::removeAssociationId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/setAssociationId": { + "post": { + "description": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "summary": "Set the associated billing item for an orphan billing item.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/setAssociationId/", + "operationId": "SoftLayer_Billing_Item::setAssociationId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/voidCancelService": { + "get": { + "description": "Void a previously made cancellation for a service ", + "summary": "Void a service cancellation that was previously made.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/voidCancelService/", + "operationId": "SoftLayer_Billing_Item::voidCancelService", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getAccount": { + "get": { + "description": "The account that a billing item belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getAccount/", + "operationId": "SoftLayer_Billing_Item::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getActiveAgreement": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getActiveAgreement/", + "operationId": "SoftLayer_Billing_Item::getActiveAgreement", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getActiveAgreementFlag": { + "get": { + "description": "A flag indicating that the billing item is under an active agreement.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getActiveAgreementFlag/", + "operationId": "SoftLayer_Billing_Item::getActiveAgreementFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getActiveAssociatedChildren": { + "get": { + "description": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getActiveAssociatedChildren/", + "operationId": "SoftLayer_Billing_Item::getActiveAssociatedChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getActiveAssociatedGuestDiskBillingItems": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getActiveAssociatedGuestDiskBillingItems/", + "operationId": "SoftLayer_Billing_Item::getActiveAssociatedGuestDiskBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getActiveBundledItems": { + "get": { + "description": "A Billing Item's active bundled billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getActiveBundledItems/", + "operationId": "SoftLayer_Billing_Item::getActiveBundledItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getActiveCancellationItem": { + "get": { + "description": "A service cancellation request item that corresponds to the billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getActiveCancellationItem/", + "operationId": "SoftLayer_Billing_Item::getActiveCancellationItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getActiveChildren": { + "get": { + "description": "A Billing Item's active child billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getActiveChildren/", + "operationId": "SoftLayer_Billing_Item::getActiveChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getActiveFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getActiveFlag/", + "operationId": "SoftLayer_Billing_Item::getActiveFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getActiveSparePoolAssociatedGuestDiskBillingItems": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getActiveSparePoolAssociatedGuestDiskBillingItems/", + "operationId": "SoftLayer_Billing_Item::getActiveSparePoolAssociatedGuestDiskBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getActiveSparePoolBundledItems": { + "get": { + "description": "A Billing Item's spare pool bundled billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getActiveSparePoolBundledItems/", + "operationId": "SoftLayer_Billing_Item::getActiveSparePoolBundledItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getAssociatedBillingItem": { + "get": { + "description": "A billing item's associated parent. This is to be used for billing items that are \"floating\", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItem/", + "operationId": "SoftLayer_Billing_Item::getAssociatedBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getAssociatedBillingItemHistory": { + "get": { + "description": "A history of billing items which a billing item has been associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItemHistory/", + "operationId": "SoftLayer_Billing_Item::getAssociatedBillingItemHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Association_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getAssociatedChildren": { + "get": { + "description": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getAssociatedChildren/", + "operationId": "SoftLayer_Billing_Item::getAssociatedChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getAssociatedParent": { + "get": { + "description": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getAssociatedParent/", + "operationId": "SoftLayer_Billing_Item::getAssociatedParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getAvailableMatchingVlans": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getAvailableMatchingVlans/", + "operationId": "SoftLayer_Billing_Item::getAvailableMatchingVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getBandwidthAllocation": { + "get": { + "description": "The bandwidth allocation for a billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getBandwidthAllocation/", + "operationId": "SoftLayer_Billing_Item::getBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allocation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getBillableChildren": { + "get": { + "description": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getBillableChildren/", + "operationId": "SoftLayer_Billing_Item::getBillableChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getBundledItems": { + "get": { + "description": "A Billing Item's bundled billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getBundledItems/", + "operationId": "SoftLayer_Billing_Item::getBundledItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getCanceledChildren": { + "get": { + "description": "A Billing Item's active child billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getCanceledChildren/", + "operationId": "SoftLayer_Billing_Item::getCanceledChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getCancellationReason": { + "get": { + "description": "The billing item's cancellation reason.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getCancellationReason/", + "operationId": "SoftLayer_Billing_Item::getCancellationReason", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Reason" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getCancellationRequests": { + "get": { + "description": "This will return any cancellation requests that are associated with this billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getCancellationRequests/", + "operationId": "SoftLayer_Billing_Item::getCancellationRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getCategory": { + "get": { + "description": "The item category to which the billing item's item belongs. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getCategory/", + "operationId": "SoftLayer_Billing_Item::getCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getChildren": { + "get": { + "description": "A Billing Item's child billing items'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getChildren/", + "operationId": "SoftLayer_Billing_Item::getChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getChildrenWithActiveAgreement": { + "get": { + "description": "A Billing Item's active child billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getChildrenWithActiveAgreement/", + "operationId": "SoftLayer_Billing_Item::getChildrenWithActiveAgreement", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getDowngradeItems": { + "get": { + "description": "For product items which have a downgrade path defined, this will return those product items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getDowngradeItems/", + "operationId": "SoftLayer_Billing_Item::getDowngradeItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getFilteredNextInvoiceChildren": { + "get": { + "description": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getFilteredNextInvoiceChildren/", + "operationId": "SoftLayer_Billing_Item::getFilteredNextInvoiceChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getHourlyFlag": { + "get": { + "description": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getHourlyFlag/", + "operationId": "SoftLayer_Billing_Item::getHourlyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getInvoiceItem": { + "get": { + "description": "Invoice items associated with this billing item", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getInvoiceItem/", + "operationId": "SoftLayer_Billing_Item::getInvoiceItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getInvoiceItems": { + "get": { + "description": "All invoice items associated with the billing item", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getInvoiceItems/", + "operationId": "SoftLayer_Billing_Item::getInvoiceItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getItem": { + "get": { + "description": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getItem/", + "operationId": "SoftLayer_Billing_Item::getItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getLocation": { + "get": { + "description": "The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getLocation/", + "operationId": "SoftLayer_Billing_Item::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getNextInvoiceChildren": { + "get": { + "description": "A Billing Item's child billing items and associated items'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getNextInvoiceChildren/", + "operationId": "SoftLayer_Billing_Item::getNextInvoiceChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getNextInvoiceTotalOneTimeAmount": { + "get": { + "description": "A Billing Item's total, including any child billing items if they exist.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeAmount/", + "operationId": "SoftLayer_Billing_Item::getNextInvoiceTotalOneTimeAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getNextInvoiceTotalOneTimeTaxAmount": { + "get": { + "description": "A Billing Item's total, including any child billing items if they exist.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeTaxAmount/", + "operationId": "SoftLayer_Billing_Item::getNextInvoiceTotalOneTimeTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getNextInvoiceTotalRecurringAmount": { + "get": { + "description": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringAmount/", + "operationId": "SoftLayer_Billing_Item::getNextInvoiceTotalRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getNextInvoiceTotalRecurringTaxAmount": { + "get": { + "description": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringTaxAmount/", + "operationId": "SoftLayer_Billing_Item::getNextInvoiceTotalRecurringTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getNonZeroNextInvoiceChildren": { + "get": { + "description": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getNonZeroNextInvoiceChildren/", + "operationId": "SoftLayer_Billing_Item::getNonZeroNextInvoiceChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getOrderItem": { + "get": { + "description": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getOrderItem/", + "operationId": "SoftLayer_Billing_Item::getOrderItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getOriginalLocation": { + "get": { + "description": "The original physical location for this billing item--may differ from current.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getOriginalLocation/", + "operationId": "SoftLayer_Billing_Item::getOriginalLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getPackage": { + "get": { + "description": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getPackage/", + "operationId": "SoftLayer_Billing_Item::getPackage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Package" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getParent": { + "get": { + "description": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getParent/", + "operationId": "SoftLayer_Billing_Item::getParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getParentVirtualGuestBillingItem": { + "get": { + "description": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getParentVirtualGuestBillingItem/", + "operationId": "SoftLayer_Billing_Item::getParentVirtualGuestBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getPendingCancellationFlag": { + "get": { + "description": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getPendingCancellationFlag/", + "operationId": "SoftLayer_Billing_Item::getPendingCancellationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getPendingOrderItem": { + "get": { + "description": "The new order item that will replace this billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getPendingOrderItem/", + "operationId": "SoftLayer_Billing_Item::getPendingOrderItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getProvisionTransaction": { + "get": { + "description": "Provisioning transaction for this billing item", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getProvisionTransaction/", + "operationId": "SoftLayer_Billing_Item::getProvisionTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getSoftwareDescription": { + "get": { + "description": "A friendly description of software component", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getSoftwareDescription/", + "operationId": "SoftLayer_Billing_Item::getSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getUpgradeItem": { + "get": { + "description": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getUpgradeItem/", + "operationId": "SoftLayer_Billing_Item::getUpgradeItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item/{SoftLayer_Billing_ItemID}/getUpgradeItems": { + "get": { + "description": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item/getUpgradeItems/", + "operationId": "SoftLayer_Billing_Item::getUpgradeItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Reason/getAllCancellationReasons": { + "get": { + "description": "getAllCancellationReasons() retrieves a list of all cancellation reasons that a server/service may be assigned to. ", + "summary": "Retrieve all available cancellation reasons. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getAllCancellationReasons/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Reason::getAllCancellationReasons", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Reason" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Reason/{SoftLayer_Billing_Item_Cancellation_ReasonID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Billing_Item_Cancellation_Reason record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getObject/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Reason::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Reason" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Reason/{SoftLayer_Billing_Item_Cancellation_ReasonID}/getBillingCancellationReasonCategory": { + "get": { + "description": "An billing cancellation reason category.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingCancellationReasonCategory/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Reason::getBillingCancellationReasonCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Reason_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Reason/{SoftLayer_Billing_Item_Cancellation_ReasonID}/getBillingItems": { + "get": { + "description": "The corresponding billing items having the specific cancellation reason.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingItems/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Reason::getBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Reason/{SoftLayer_Billing_Item_Cancellation_ReasonID}/getTranslatedReason": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getTranslatedReason/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Reason::getTranslatedReason", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Reason_Category/getAllCancellationReasonCategories": { + "get": { + "description": "getAllCancellationReasonCategories() retrieves a list of all cancellation reason categories ", + "summary": "Retrieve all available cancellation reason categories. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getAllCancellationReasonCategories/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Reason_Category::getAllCancellationReasonCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Reason_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Reason_Category/{SoftLayer_Billing_Item_Cancellation_Reason_CategoryID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Billing_Item_Cancellation_Reason_Category record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getObject/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Reason_Category::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Reason_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Reason_Category/{SoftLayer_Billing_Item_Cancellation_Reason_CategoryID}/getBillingCancellationReasons": { + "get": { + "description": "The corresponding billing cancellation reasons having the specific billing cancellation reason category.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getBillingCancellationReasons/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Reason_Category::getBillingCancellationReasons", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Reason" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/createObject": { + "post": { + "description": "This method creates a service cancellation request. \n\nYou need to have \"Cancel Services\" privilege to create a cancellation request. You have to provide at least one SoftLayer_Billing_Item_Cancellation_Request_Item in the \"items\" property. Make sure billing item's category code belongs to the cancelable product codes. You can retrieve the cancelable product category by the [[SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories|product category]] service. ", + "summary": "Creates a cancellation request.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/createObject/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/getAllCancellationRequests": { + "get": { + "description": "This method returns all service cancellation requests. \n\nMake sure to include the \"resultLimit\" in the SOAP request header for quicker response. If there is no result limit header is passed, it will return the latest 25 results by default. ", + "summary": "Returns all service cancellation requests", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAllCancellationRequests/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::getAllCancellationRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/getCancellationCutoffDate": { + "post": { + "description": "Services can be canceled 2 or 3 days prior to your next bill date. This service returns the time by which a cancellation request submission is permitted in the current billing cycle. If the current time falls into the cut off date, this will return next earliest cancellation cut off date. \n\nAvailable category codes are: service, server ", + "summary": "Returns service cancellation cut off date.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getCancellationCutoffDate/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::getCancellationCutoffDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/{SoftLayer_Billing_Item_Cancellation_RequestID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Billing_Item_Cancellation_Request object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item_Cancellation_Request service. You can only retrieve cancellation request records that are assigned to your SoftLayer account. ", + "summary": "Retrieve a SoftLayer_Billing_Item_Cancellation_Request record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getObject/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/{SoftLayer_Billing_Item_Cancellation_RequestID}/removeCancellationItem": { + "post": { + "description": "This method removes a cancellation item from a cancellation request that is in \"Pending\" or \"Approved\" status. ", + "summary": "Removes a cancellation item", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/removeCancellationItem/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::removeCancellationItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/validateBillingItemForCancellation": { + "post": { + "description": "This method examined if a billing item is eligible for cancellation. It checks if the billing item you provided is already in your existing cancellation request. ", + "summary": "Examined if a billing item can be canceled or not.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/validateBillingItemForCancellation/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::validateBillingItemForCancellation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/{SoftLayer_Billing_Item_Cancellation_RequestID}/void": { + "post": { + "description": "This method voids a service cancellation request in \"Pending\" or \"Approved\" status. ", + "summary": "Voids a pending or approved cancellation request", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/void/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::void", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/{SoftLayer_Billing_Item_Cancellation_RequestID}/getAccount": { + "get": { + "description": "The SoftLayer account that a service cancellation request belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAccount/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/{SoftLayer_Billing_Item_Cancellation_RequestID}/getItems": { + "get": { + "description": "A collection of service cancellation items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getItems/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::getItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/{SoftLayer_Billing_Item_Cancellation_RequestID}/getStatus": { + "get": { + "description": "The status of a service cancellation request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getStatus/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/{SoftLayer_Billing_Item_Cancellation_RequestID}/getTicket": { + "get": { + "description": "The ticket that is associated with the service cancellation request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getTicket/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::getTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Cancellation_Request/{SoftLayer_Billing_Item_Cancellation_RequestID}/getUser": { + "get": { + "description": "The user that initiated a service cancellation request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getUser/", + "operationId": "SoftLayer_Billing_Item_Cancellation_Request::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Chronicle/{SoftLayer_Billing_Item_ChronicleID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Billing_Item_Chronicle record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Chronicle/getObject/", + "operationId": "SoftLayer_Billing_Item_Chronicle::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Chronicle" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Chronicle/{SoftLayer_Billing_Item_ChronicleID}/getAssociatedChildren": { + "get": { + "description": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Chronicle/getAssociatedChildren/", + "operationId": "SoftLayer_Billing_Item_Chronicle::getAssociatedChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Chronicle" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Chronicle/{SoftLayer_Billing_Item_ChronicleID}/getProduct": { + "get": { + "description": "The entry in the product catalog that the underlying billing item is based on.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Chronicle/getProduct/", + "operationId": "SoftLayer_Billing_Item_Chronicle::getProduct", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Billing_Item_Virtual_DedicatedHost record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getObject/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Virtual_DedicatedHost" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/cancelItem": { + "post": { + "description": "Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the \"cancelImmediately\" property to true will start the cancellation immediately if the item is eligible to be canceled immediately. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "summary": "Cancel a service or resource.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelItem/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::cancelItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/cancelService": { + "get": { + "description": "Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly. ", + "summary": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelService/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::cancelService", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/cancelServiceOnAnniversaryDate": { + "get": { + "description": "Cancel the resource or service for a billing Item ", + "summary": "Cancel a service or resource on the next bill date", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelServiceOnAnniversaryDate/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::cancelServiceOnAnniversaryDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/getServiceBillingItemsByCategory": { + "post": { + "description": "This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [[SoftLayer_Security_Certificate_Request|service cancellation]] service. \n\nIn order to find billing items for cancellation, use [[SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories|product categories]] service to retrieve category codes that are eligible for cancellation. ", + "summary": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getServiceBillingItemsByCategory/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getServiceBillingItemsByCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/removeAssociationId": { + "get": { + "description": "Remove the association from a billing item. ", + "summary": "Remove an association from an orphan billing item.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/removeAssociationId/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::removeAssociationId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/setAssociationId": { + "post": { + "description": "Set an associated billing item to an orphan billing item. Associations allow you to tie an \"orphaned\" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set. ", + "summary": "Set the associated billing item for an orphan billing item.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/setAssociationId/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::setAssociationId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/voidCancelService": { + "get": { + "description": "Void a previously made cancellation for a service ", + "summary": "Void a service cancellation that was previously made.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/voidCancelService/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::voidCancelService", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getResource": { + "get": { + "description": "The resource for a virtual dedicated host billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getResource/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getResource", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_DedicatedHost" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getAccount": { + "get": { + "description": "The account that a billing item belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAccount/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getActiveAgreement": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreement/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getActiveAgreement", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getActiveAgreementFlag": { + "get": { + "description": "A flag indicating that the billing item is under an active agreement.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreementFlag/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getActiveAgreementFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Agreement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getActiveAssociatedChildren": { + "get": { + "description": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedChildren/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getActiveAssociatedChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getActiveAssociatedGuestDiskBillingItems": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedGuestDiskBillingItems/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getActiveAssociatedGuestDiskBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getActiveBundledItems": { + "get": { + "description": "A Billing Item's active bundled billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveBundledItems/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getActiveBundledItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getActiveCancellationItem": { + "get": { + "description": "A service cancellation request item that corresponds to the billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveCancellationItem/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getActiveCancellationItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getActiveChildren": { + "get": { + "description": "A Billing Item's active child billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveChildren/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getActiveChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getActiveFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveFlag/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getActiveFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getActiveSparePoolAssociatedGuestDiskBillingItems": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolAssociatedGuestDiskBillingItems/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getActiveSparePoolAssociatedGuestDiskBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getActiveSparePoolBundledItems": { + "get": { + "description": "A Billing Item's spare pool bundled billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolBundledItems/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getActiveSparePoolBundledItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getAssociatedBillingItem": { + "get": { + "description": "A billing item's associated parent. This is to be used for billing items that are \"floating\", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItem/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getAssociatedBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getAssociatedBillingItemHistory": { + "get": { + "description": "A history of billing items which a billing item has been associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItemHistory/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getAssociatedBillingItemHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Association_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getAssociatedChildren": { + "get": { + "description": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedChildren/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getAssociatedChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getAssociatedParent": { + "get": { + "description": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedParent/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getAssociatedParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getAvailableMatchingVlans": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAvailableMatchingVlans/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getAvailableMatchingVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getBandwidthAllocation": { + "get": { + "description": "The bandwidth allocation for a billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBandwidthAllocation/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allocation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getBillableChildren": { + "get": { + "description": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBillableChildren/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getBillableChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getBundledItems": { + "get": { + "description": "A Billing Item's bundled billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundledItems/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getBundledItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getCanceledChildren": { + "get": { + "description": "A Billing Item's active child billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCanceledChildren/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getCanceledChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getCancellationReason": { + "get": { + "description": "The billing item's cancellation reason.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationReason/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getCancellationReason", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Reason" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getCancellationRequests": { + "get": { + "description": "This will return any cancellation requests that are associated with this billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationRequests/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getCancellationRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getCategory": { + "get": { + "description": "The item category to which the billing item's item belongs. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCategory/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getChildren": { + "get": { + "description": "A Billing Item's child billing items'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildren/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getChildrenWithActiveAgreement": { + "get": { + "description": "A Billing Item's active child billing items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildrenWithActiveAgreement/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getChildrenWithActiveAgreement", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getDowngradeItems": { + "get": { + "description": "For product items which have a downgrade path defined, this will return those product items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getDowngradeItems/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getDowngradeItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getFilteredNextInvoiceChildren": { + "get": { + "description": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getFilteredNextInvoiceChildren/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getFilteredNextInvoiceChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getHourlyFlag": { + "get": { + "description": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getHourlyFlag/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getHourlyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getInvoiceItem": { + "get": { + "description": "Invoice items associated with this billing item", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItem/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getInvoiceItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getInvoiceItems": { + "get": { + "description": "All invoice items associated with the billing item", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItems/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getInvoiceItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getItem": { + "get": { + "description": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getItem/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getLocation": { + "get": { + "description": "The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getLocation/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getNextInvoiceChildren": { + "get": { + "description": "A Billing Item's child billing items and associated items'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceChildren/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getNextInvoiceChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getNextInvoiceTotalOneTimeAmount": { + "get": { + "description": "A Billing Item's total, including any child billing items if they exist.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeAmount/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getNextInvoiceTotalOneTimeAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getNextInvoiceTotalOneTimeTaxAmount": { + "get": { + "description": "A Billing Item's total, including any child billing items if they exist.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeTaxAmount/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getNextInvoiceTotalOneTimeTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getNextInvoiceTotalRecurringAmount": { + "get": { + "description": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringAmount/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getNextInvoiceTotalRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getNextInvoiceTotalRecurringTaxAmount": { + "get": { + "description": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringTaxAmount/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getNextInvoiceTotalRecurringTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getNonZeroNextInvoiceChildren": { + "get": { + "description": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNonZeroNextInvoiceChildren/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getNonZeroNextInvoiceChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getOrderItem": { + "get": { + "description": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOrderItem/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getOrderItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getOriginalLocation": { + "get": { + "description": "The original physical location for this billing item--may differ from current.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOriginalLocation/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getOriginalLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getPackage": { + "get": { + "description": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPackage/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getPackage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Package" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getParent": { + "get": { + "description": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParent/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getParentVirtualGuestBillingItem": { + "get": { + "description": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParentVirtualGuestBillingItem/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getParentVirtualGuestBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getPendingCancellationFlag": { + "get": { + "description": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingCancellationFlag/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getPendingCancellationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getPendingOrderItem": { + "get": { + "description": "The new order item that will replace this billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingOrderItem/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getPendingOrderItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getProvisionTransaction": { + "get": { + "description": "Provisioning transaction for this billing item", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getProvisionTransaction/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getProvisionTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getSoftwareDescription": { + "get": { + "description": "A friendly description of software component", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getSoftwareDescription/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getUpgradeItem": { + "get": { + "description": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItem/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getUpgradeItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Item_Virtual_DedicatedHost/{SoftLayer_Billing_Item_Virtual_DedicatedHostID}/getUpgradeItems": { + "get": { + "description": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItems/", + "operationId": "SoftLayer_Billing_Item_Virtual_DedicatedHost::getUpgradeItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/approveModifiedOrder": { + "get": { + "description": "When an order has been modified, the customer will need to approve the changes. This method will allow the customer to approve the changes. ", + "summary": "Approve the changes of a modified order", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/approveModifiedOrder/", + "operationId": "SoftLayer_Billing_Order::approveModifiedOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/getAllObjects": { + "get": { + "description": "This will get all billing orders for your account. ", + "summary": "Get all billing orders for your account", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getAllObjects/", + "operationId": "SoftLayer_Billing_Order::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Billing_Order object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Order service. You can only retrieve orders that are assigned to your portal user's account. ", + "summary": "Retrieve a SoftLayer_Billing_Order record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getObject/", + "operationId": "SoftLayer_Billing_Order::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/getOrderStatuses": { + "get": { + "description": "Get a list of [[SoftLayer_Container_Billing_Order_Status]] objects. ", + "summary": "Get a list of SoftLayer_Container_Billing_Order_Status objects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderStatuses/", + "operationId": "SoftLayer_Billing_Order::getOrderStatuses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Billing_Order_Status" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getPdf": { + "get": { + "description": "Retrieve a PDF record of a SoftLayer quote. If the order is not a quote, an error will be thrown. ", + "summary": "Retrieve a PDF copy of a quote.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getPdf/", + "operationId": "SoftLayer_Billing_Order::getPdf", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getPdfFilename": { + "get": { + "description": "Retrieve the default filename of an order PDF. ", + "summary": "Retrieve the default name of the PDF", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getPdfFilename/", + "operationId": "SoftLayer_Billing_Order::getPdfFilename", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getRecalculatedOrderContainer": { + "post": { + "description": "Generate an [[SoftLayer_Container_Product_Order|order container]] from a billing order. This will take into account promotions, reseller status, estimated taxes and all other standard order verification processes. ", + "summary": "Generate an [[SoftLayer_Container_Product_Order|order container]] from a billing order. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getRecalculatedOrderContainer/", + "operationId": "SoftLayer_Billing_Order::getRecalculatedOrderContainer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getReceipt": { + "get": { + "description": "Generate a [[SoftLayer_Container_Product_Order_Receipt]] object with all the order information. ", + "summary": "Generate and return an order receipt.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getReceipt/", + "operationId": "SoftLayer_Billing_Order::getReceipt", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Receipt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/isPendingEditApproval": { + "get": { + "description": "When an order has been modified, it will contain a status indicating so. This method checks that status and also verifies that the active user's account is the same as the account on the order. ", + "summary": "Determine if the existing order is pending edit approval", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/isPendingEditApproval/", + "operationId": "SoftLayer_Billing_Order::isPendingEditApproval", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getAccount": { + "get": { + "description": "The [[SoftLayer_Account|account]] to which an order belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getAccount/", + "operationId": "SoftLayer_Billing_Order::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getBrand": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getBrand/", + "operationId": "SoftLayer_Billing_Order::getBrand", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getCart": { + "get": { + "description": "A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See [[SoftLayer_Billing_Order_Cart]] for more information.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getCart/", + "operationId": "SoftLayer_Billing_Order::getCart", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Cart" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getCoreRestrictedItems": { + "get": { + "description": "The [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restricted", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getCoreRestrictedItems/", + "operationId": "SoftLayer_Billing_Order::getCoreRestrictedItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getCreditCardTransactions": { + "get": { + "description": "All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getCreditCardTransactions/", + "operationId": "SoftLayer_Billing_Order::getCreditCardTransactions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_Card_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getExchangeRate": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getExchangeRate/", + "operationId": "SoftLayer_Billing_Order::getExchangeRate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Currency_ExchangeRate" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getInitialInvoice": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getInitialInvoice/", + "operationId": "SoftLayer_Billing_Order::getInitialInvoice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getItems": { + "get": { + "description": "The SoftLayer_Billing_Order_items included in an order.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getItems/", + "operationId": "SoftLayer_Billing_Order::getItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderApprovalDate": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderApprovalDate/", + "operationId": "SoftLayer_Billing_Order::getOrderApprovalDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderNonServerMonthlyAmount": { + "get": { + "description": "An order's non-server items total monthly fee.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderNonServerMonthlyAmount/", + "operationId": "SoftLayer_Billing_Order::getOrderNonServerMonthlyAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderServerMonthlyAmount": { + "get": { + "description": "An order's server items total monthly fee.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderServerMonthlyAmount/", + "operationId": "SoftLayer_Billing_Order::getOrderServerMonthlyAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderTopLevelItems": { + "get": { + "description": "An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderTopLevelItems/", + "operationId": "SoftLayer_Billing_Order::getOrderTopLevelItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderTotalAmount": { + "get": { + "description": "This amount represents the order's initial charge including set up fee and taxes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderTotalAmount/", + "operationId": "SoftLayer_Billing_Order::getOrderTotalAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderTotalOneTime": { + "get": { + "description": "An order's total one time amount summing all the set up fees, the labor fees and the one time fees. Taxes will be applied for non-tax-exempt. This amount represents the initial fees that will be charged.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTime/", + "operationId": "SoftLayer_Billing_Order::getOrderTotalOneTime", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderTotalOneTimeAmount": { + "get": { + "description": "An order's total one time amount. This amount represents the initial fees before tax.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeAmount/", + "operationId": "SoftLayer_Billing_Order::getOrderTotalOneTimeAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderTotalOneTimeTaxAmount": { + "get": { + "description": "An order's total one time tax amount. This amount represents the tax that will be applied to the total charge, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeTaxAmount/", + "operationId": "SoftLayer_Billing_Order::getOrderTotalOneTimeTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderTotalRecurring": { + "get": { + "description": "An order's total recurring amount. Taxes will be applied for non-tax-exempt. This amount represents the fees that will be charged on a recurring (usually monthly) basis.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurring/", + "operationId": "SoftLayer_Billing_Order::getOrderTotalRecurring", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderTotalRecurringAmount": { + "get": { + "description": "An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringAmount/", + "operationId": "SoftLayer_Billing_Order::getOrderTotalRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderTotalRecurringTaxAmount": { + "get": { + "description": "The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringTaxAmount/", + "operationId": "SoftLayer_Billing_Order::getOrderTotalRecurringTaxAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderTotalSetupAmount": { + "get": { + "description": "An order's total setup fee.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderTotalSetupAmount/", + "operationId": "SoftLayer_Billing_Order::getOrderTotalSetupAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getOrderType": { + "get": { + "description": "The type of an order. This lets you know where this order was generated from.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getOrderType/", + "operationId": "SoftLayer_Billing_Order::getOrderType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getPaypalTransactions": { + "get": { + "description": "All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getPaypalTransactions/", + "operationId": "SoftLayer_Billing_Order::getPaypalTransactions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Payment_PayPal_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getPresaleEvent": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getPresaleEvent/", + "operationId": "SoftLayer_Billing_Order::getPresaleEvent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Sales_Presale_Event" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getQuote": { + "get": { + "description": "The quote of an order. This quote holds information about its expiration date, creation date, name and status. This information is tied to an order having the status 'QUOTE'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getQuote/", + "operationId": "SoftLayer_Billing_Order::getQuote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getReferralPartner": { + "get": { + "description": "The Referral Partner who referred this order. (Only necessary for new customer orders)", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getReferralPartner/", + "operationId": "SoftLayer_Billing_Order::getReferralPartner", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getUpgradeRequestFlag": { + "get": { + "description": "This flag indicates an order is an upgrade.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getUpgradeRequestFlag/", + "operationId": "SoftLayer_Billing_Order::getUpgradeRequestFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order/{SoftLayer_Billing_OrderID}/getUserRecord": { + "get": { + "description": "The SoftLayer_User_Customer object tied to an order.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order/getUserRecord/", + "operationId": "SoftLayer_Billing_Order::getUserRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/createCart": { + "post": { + "description": "When creating a new cart, the order data is sent through SoftLayer_Product_Order::verifyOrder to make sure that the cart contains valid data. If an issue is found with the order, an exception will be thrown and you will receive the same response as if SoftLayer_Product_Order::verifyOrder were called directly. Once the order verification is complete, the cart will be created. \n\nThe response is the new cart id. ", + "summary": "Create a new cart from the order data provided", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/createCart/", + "operationId": "SoftLayer_Billing_Order_Cart::createCart", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/deleteCart": { + "get": { + "description": "If a cart is no longer needed, it can be deleted using this service. Once a cart has been deleted, it cannot be retrieved again. ", + "summary": "Delete an existing cart", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/deleteCart/", + "operationId": "SoftLayer_Billing_Order_Cart::deleteCart", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/getCartByCartKey": { + "post": { + "description": "Retrieve a valid cart record of a SoftLayer order. ", + "summary": "Retrieve a cart.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/getCartByCartKey/", + "operationId": "SoftLayer_Billing_Order_Cart::getCartByCartKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Cart" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Billing_Order_Cart record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/getObject/", + "operationId": "SoftLayer_Billing_Order_Cart::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Cart" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/getPdf": { + "get": { + "description": "Retrieve a PDF copy of the cart. ", + "summary": "Retrieve a PDF copy of the cart.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/getPdf/", + "operationId": "SoftLayer_Billing_Order_Cart::getPdf", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/getRecalculatedOrderContainer": { + "post": { + "description": "This method allows the customer to retrieve a saved cart and put it in a format that's suitable to be sent to SoftLayer_Billing_Order_Cart::createCart to create a new cart or to SoftLayer_Billing_Order_Cart::updateCart to update an existing cart. ", + "summary": "Retrieve order container from a saved cart", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/getRecalculatedOrderContainer/", + "operationId": "SoftLayer_Billing_Order_Cart::getRecalculatedOrderContainer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/updateCart": { + "post": { + "description": "Like SoftLayer_Billing_Order_Cart::createCart, the order data will be sent through SoftLayer_Product_Order::verifyOrder to make sure that the updated cart information is valid. Once it has been verified, the new order data will be saved. \n\nThis will return the cart id. ", + "summary": "Update an existing cart with the modified order data", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/updateCart/", + "operationId": "SoftLayer_Billing_Order_Cart::updateCart", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/claim": { + "post": { + "description": "This method is used to transfer an anonymous quote to the active user and associated account. An anonymous quote is one that was created by a user without being authenticated. If a quote was created anonymously and then the customer attempts to access that anonymous quote via the API (which requires authentication), the customer will be unable to retrieve the quote due to the security restrictions in place. By providing the ability for a customer to claim a quote, s/he will be able to pull the anonymous quote onto his/her account and successfully view the quote. \n\nTo claim a quote, both the quote id and the quote key (the 32-character random string) must be provided. ", + "summary": "Claim an anonymous quote", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/claim/", + "operationId": "SoftLayer_Billing_Order_Cart::claim", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/deleteQuote": { + "get": { + "description": "Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order. ", + "summary": "Delete the quote of an order", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/deleteQuote/", + "operationId": "SoftLayer_Billing_Order_Cart::deleteQuote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/getQuoteByQuoteKey": { + "post": { + "description": "This method will return a [[SoftLayer_Billing_Order_Quote]] that is identified by the quote key specified. If you do not have access to the quote or it does not exist, an exception will be thrown indicating so. ", + "summary": "Retrieve a [[SoftLayer_Billing_Order_Quote]] by the quote key specified.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/getQuoteByQuoteKey/", + "operationId": "SoftLayer_Billing_Order_Cart::getQuoteByQuoteKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/placeOrder": { + "post": { + "description": "Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval. ", + "summary": "Place an order", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/placeOrder/", + "operationId": "SoftLayer_Billing_Order_Cart::placeOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Receipt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/placeQuote": { + "post": { + "description": "Use this method for placing server quotes and additional services quotes. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server quotes. In addition to verifying the quote, placeQuote() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. ", + "summary": "Saves changes to a quote", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/placeQuote/", + "operationId": "SoftLayer_Billing_Order_Cart::placeQuote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/saveQuote": { + "get": { + "description": "Account master users and sub-users in the SoftLayer customer portal can save the quote of an order to avoid its deletion after 5 days or its expiration after 2 days. ", + "summary": "Save the quote of an order", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/saveQuote/", + "operationId": "SoftLayer_Billing_Order_Cart::saveQuote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/verifyOrder": { + "post": { + "description": "Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval. ", + "summary": "Verify an order", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/verifyOrder/", + "operationId": "SoftLayer_Billing_Order_Cart::verifyOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/withdrawGdprAcceptance": { + "get": { + "description": "Withdraws the users acceptance of the GDPR terms. ", + "summary": "Withdraws the users acceptance of the GDPR terms.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/withdrawGdprAcceptance/", + "operationId": "SoftLayer_Billing_Order_Cart::withdrawGdprAcceptance", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/getAccount": { + "get": { + "description": "A quote's corresponding account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/getAccount/", + "operationId": "SoftLayer_Billing_Order_Cart::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/getDoNotContactFlag": { + "get": { + "description": "Indicates whether the owner of the quote chosen to no longer be contacted.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/getDoNotContactFlag/", + "operationId": "SoftLayer_Billing_Order_Cart::getDoNotContactFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/getOrder": { + "get": { + "description": "This order contains the records for which products were selected for this quote.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/getOrder/", + "operationId": "SoftLayer_Billing_Order_Cart::getOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Cart/{SoftLayer_Billing_Order_CartID}/getOrdersFromQuote": { + "get": { + "description": "These are all the orders that were created from this quote.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Cart/getOrdersFromQuote/", + "operationId": "SoftLayer_Billing_Order_Cart::getOrdersFromQuote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are \"parent\" billing items and \"child\" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered \"child\" billing items. ", + "summary": "Retrieve a SoftLayer_Billing_Order_Item record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getObject/", + "operationId": "SoftLayer_Billing_Order_Item::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getBillingItem": { + "get": { + "description": "The SoftLayer_Billing_Item tied to the order item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getBillingItem/", + "operationId": "SoftLayer_Billing_Order_Item::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getBundledItems": { + "get": { + "description": "The other items included with an ordered item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getBundledItems/", + "operationId": "SoftLayer_Billing_Order_Item::getBundledItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getCategory": { + "get": { + "description": "The item category tied to an order item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getCategory/", + "operationId": "SoftLayer_Billing_Order_Item::getCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getChildren": { + "get": { + "description": "The child order items for an order item. All server order items should have children. These children are considered a part of the server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getChildren/", + "operationId": "SoftLayer_Billing_Order_Item::getChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getGlobalIdentifier": { + "get": { + "description": "A hardware's universally unique identifier.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getGlobalIdentifier/", + "operationId": "SoftLayer_Billing_Order_Item::getGlobalIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getHardwareGenericComponent": { + "get": { + "description": "The component type tied to an order item. All hardware-specific items should have a generic hardware component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getHardwareGenericComponent/", + "operationId": "SoftLayer_Billing_Order_Item::getHardwareGenericComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model_Generic" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getItem": { + "get": { + "description": "The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getItem/", + "operationId": "SoftLayer_Billing_Order_Item::getItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getItemCategoryAnswers": { + "get": { + "description": "This is an item's category answers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getItemCategoryAnswers/", + "operationId": "SoftLayer_Billing_Order_Item::getItemCategoryAnswers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item_Category_Answer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getItemPrice": { + "get": { + "description": "The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getItemPrice/", + "operationId": "SoftLayer_Billing_Order_Item::getItemPrice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getLocation": { + "get": { + "description": "The location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getLocation/", + "operationId": "SoftLayer_Billing_Order_Item::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getNextOrderChildren": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getNextOrderChildren/", + "operationId": "SoftLayer_Billing_Order_Item::getNextOrderChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getOldBillingItem": { + "get": { + "description": "This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getOldBillingItem/", + "operationId": "SoftLayer_Billing_Order_Item::getOldBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getOrder": { + "get": { + "description": "The order to which this item belongs. The order contains all the information related to the items included in an order", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getOrder/", + "operationId": "SoftLayer_Billing_Order_Item::getOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getOrderApprovalDate": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getOrderApprovalDate/", + "operationId": "SoftLayer_Billing_Order_Item::getOrderApprovalDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getPackage": { + "get": { + "description": "The SoftLayer_Product_Package an order item is a part of.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getPackage/", + "operationId": "SoftLayer_Billing_Order_Item::getPackage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Package" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getParent": { + "get": { + "description": "The parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getParent/", + "operationId": "SoftLayer_Billing_Order_Item::getParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getPreset": { + "get": { + "description": "The SoftLayer_Product_Package_Preset related to this order item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getPreset/", + "operationId": "SoftLayer_Billing_Order_Item::getPreset", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getPromoCode": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getPromoCode/", + "operationId": "SoftLayer_Billing_Order_Item::getPromoCode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Promotion" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getRedundantPowerSupplyCount": { + "get": { + "description": "A count of power supplies contained within this SoftLayer_Billing_Order", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getRedundantPowerSupplyCount/", + "operationId": "SoftLayer_Billing_Order_Item::getRedundantPowerSupplyCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getSoftwareDescription": { + "get": { + "description": "For ordered items that are software items, a full description of that software can be found with this property. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getSoftwareDescription/", + "operationId": "SoftLayer_Billing_Order_Item::getSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getStorageGroups": { + "get": { + "description": "The drive storage groups that are attached to this billing order item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getStorageGroups/", + "operationId": "SoftLayer_Billing_Order_Item::getStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group_Order" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getTotalRecurringAmount": { + "get": { + "description": "The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getTotalRecurringAmount/", + "operationId": "SoftLayer_Billing_Order_Item::getTotalRecurringAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Item/{SoftLayer_Billing_Order_ItemID}/getUpgradeItem": { + "get": { + "description": "The next SoftLayer_Product_Item in the upgrade path for this order item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Item/getUpgradeItem/", + "operationId": "SoftLayer_Billing_Order_Item::getUpgradeItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/claim": { + "post": { + "description": "This method is used to transfer an anonymous quote to the active user and associated account. An anonymous quote is one that was created by a user without being authenticated. If a quote was created anonymously and then the customer attempts to access that anonymous quote via the API (which requires authentication), the customer will be unable to retrieve the quote due to the security restrictions in place. By providing the ability for a customer to claim a quote, s/he will be able to pull the anonymous quote onto his/her account and successfully view the quote. \n\nTo claim a quote, both the quote id and the quote key (the 32-character random string) must be provided. ", + "summary": "Claim an anonymous quote", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/claim/", + "operationId": "SoftLayer_Billing_Order_Quote::claim", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/deleteQuote": { + "get": { + "description": "Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order. ", + "summary": "Delete the quote of an order", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/deleteQuote/", + "operationId": "SoftLayer_Billing_Order_Quote::deleteQuote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Billing_Order_Quote object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Order_Quote service. You can only retrieve quotes that are assigned to your portal user's account. ", + "summary": "Retrieve a SoftLayer_Billing_Order_Quote record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/getObject/", + "operationId": "SoftLayer_Billing_Order_Quote::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/getPdf": { + "get": { + "description": "Retrieve a PDF record of a SoftLayer quoted order. SoftLayer keeps PDF records of all quoted orders for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these quoted order files. ", + "summary": "Retrieve a PDF copy of a quote.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/getPdf/", + "operationId": "SoftLayer_Billing_Order_Quote::getPdf", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/getQuoteByQuoteKey": { + "post": { + "description": "This method will return a [[SoftLayer_Billing_Order_Quote]] that is identified by the quote key specified. If you do not have access to the quote or it does not exist, an exception will be thrown indicating so. ", + "summary": "Retrieve a [[SoftLayer_Billing_Order_Quote]] by the quote key specified.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/getQuoteByQuoteKey/", + "operationId": "SoftLayer_Billing_Order_Quote::getQuoteByQuoteKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/getRecalculatedOrderContainer": { + "post": { + "description": "Generate an [[SoftLayer_Container_Product_Order|order container]] from the previously-created quote. This will take into account promotions, reseller status, estimated taxes and all other standard order verification processes. ", + "summary": "Generate an [[SoftLayer_Container_Product_Order|order container]] from the previously-created quote. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/getRecalculatedOrderContainer/", + "operationId": "SoftLayer_Billing_Order_Quote::getRecalculatedOrderContainer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/placeOrder": { + "post": { + "description": "Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval. ", + "summary": "Place an order", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/placeOrder/", + "operationId": "SoftLayer_Billing_Order_Quote::placeOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Receipt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/placeQuote": { + "post": { + "description": "Use this method for placing server quotes and additional services quotes. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server quotes. In addition to verifying the quote, placeQuote() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. ", + "summary": "Saves changes to a quote", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/placeQuote/", + "operationId": "SoftLayer_Billing_Order_Quote::placeQuote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/saveQuote": { + "get": { + "description": "Account master users and sub-users in the SoftLayer customer portal can save the quote of an order to avoid its deletion after 5 days or its expiration after 2 days. ", + "summary": "Save the quote of an order", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/saveQuote/", + "operationId": "SoftLayer_Billing_Order_Quote::saveQuote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Quote" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/verifyOrder": { + "post": { + "description": "Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval. ", + "summary": "Verify an order", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/verifyOrder/", + "operationId": "SoftLayer_Billing_Order_Quote::verifyOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/withdrawGdprAcceptance": { + "get": { + "description": "Withdraws the users acceptance of the GDPR terms. ", + "summary": "Withdraws the users acceptance of the GDPR terms.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/withdrawGdprAcceptance/", + "operationId": "SoftLayer_Billing_Order_Quote::withdrawGdprAcceptance", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/getAccount": { + "get": { + "description": "A quote's corresponding account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/getAccount/", + "operationId": "SoftLayer_Billing_Order_Quote::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/getDoNotContactFlag": { + "get": { + "description": "Indicates whether the owner of the quote chosen to no longer be contacted.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/getDoNotContactFlag/", + "operationId": "SoftLayer_Billing_Order_Quote::getDoNotContactFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/getOrder": { + "get": { + "description": "This order contains the records for which products were selected for this quote.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/getOrder/", + "operationId": "SoftLayer_Billing_Order_Quote::getOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Billing_Order_Quote/{SoftLayer_Billing_Order_QuoteID}/getOrdersFromQuote": { + "get": { + "description": "These are all the orders that were created from this quote.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Billing_Order_Quote/getOrdersFromQuote/", + "operationId": "SoftLayer_Billing_Order_Quote::getOrdersFromQuote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/createCustomerAccount": { + "post": { + "description": "Create a new customer account record. By default, the newly created account will be associated to a platform (PaaS) account. To skip the automatic creation and linking to a new platform account, set the bluemixLinkedFlag to false on the account template. ", + "summary": "Create a new customer account record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/createCustomerAccount/", + "operationId": "SoftLayer_Brand::createCustomerAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/createObject": { + "post": { + "description": "\ncreateObject() allows the creation of a new brand. This will also create an `account` \nto serve as the owner of the brand. \n\n\nIn order to create a brand, a template object must be sent in with several required values. \n\n\n### Input [[SoftLayer_Brand]]\n\n\n\n- `name` \n + Name of brand \n + Required \n + Type: string \n- `keyName` \n + Reference key name \n + Required \n + Type: string \n- `longName` \n + More descriptive name of brand \n + Required \n + Type: string \n- `account.firstName` \n + First Name of account contact \n + Required \n + Type: string \n- `account.lastName` \n + Last Name of account contact \n + Required \n + Type: string \n- `account.address1` \n + Street Address of company \n + Required \n + Type: string \n- `account.address2` \n + Street Address of company \n + Optional \n + Type: string \n- `account.city` \n + City of company \n + Required \n + Type: string \n- `account.state` \n + State of company (if applicable) \n + Conditionally Required \n + Type: string \n- `account.postalCode` \n + Postal Code of company \n + Required \n + Type: string \n- `account.country` \n + Country of company \n + Required \n + Type: string \n- `account.officePhone` \n + Office Phone number of Company \n + Required \n + Type: string \n- `account.alternatePhone` \n + Alternate Phone number of Company \n + Optional \n + Type: string \n- `account.companyName` \n + Name of company \n + Required \n + Type: string \n- `account.email` \n + Email address of account contact \n + Required \n + Type: string \n\n\nREST Example: \n``` \ncurl -X POST -d '{ \n \"parameters\":[{ \n \"name\": \"Brand Corp\", \n \"keyName\": \"BRAND_CORP\", \n \"longName\": \"Brand Corporation\", \n \"account\": { \n \"firstName\": \"Gloria\", \n \"lastName\": \"Brand\", \n \"address1\": \"123 Drive\", \n \"city\": \"Boston\", \n \"state\": \"MA\", \n \"postalCode\": \"02107\", \n \"country\": \"US\", \n \"companyName\": \"Brand Corp\", \n \"officePhone\": \"857-111-1111\", \n \"email\": \"noreply@example.com\" \n } \n }] \n}' https://api.softlayer.com/rest/v3.1/SoftLayer_Brand/createObject.json \n``` ", + "summary": "Create a new brand.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/createObject/", + "operationId": "SoftLayer_Brand::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/disableAccount": { + "post": { + "description": "Disable an account associated with this Brand. Anything that would disqualify the account from being disabled will cause an exception to be raised. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/disableAccount/", + "operationId": "SoftLayer_Brand::disableAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getAllTicketSubjects": { + "post": { + "description": "(DEPRECATED) Use [[SoftLayer_Ticket_Subject::getAllObjects]] method. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getAllTicketSubjects/", + "operationId": "SoftLayer_Brand::getAllTicketSubjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Subject" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getBillingItemSnapshotsForSingleOwnedAccount": { + "post": { + "description": "This service returns the snapshots of billing items recorded periodically given an account ID. The provided account ID must be owned by the brand that calls this service. In this context, it can be interpreted that the billing items snapshots belong to both the account and that accounts brand. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. \n\nThe downside is, they are not real time, and do not share relational parity with the original billing item. ", + "summary": "Returns billing item snapshots on accounts owned by specific brands.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getBillingItemSnapshotsForSingleOwnedAccount/", + "operationId": "SoftLayer_Brand::getBillingItemSnapshotsForSingleOwnedAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Chronicle" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getBillingItemSnapshotsWithExternalAccountId": { + "post": { + "description": "This service returns the snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. \n\nThe downside is, they are not real time, and do not share relational parity with the original billing item. ", + "summary": "Returns billing item snapshots on accounts owned by specific brands.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getBillingItemSnapshotsWithExternalAccountId/", + "operationId": "SoftLayer_Brand::getBillingItemSnapshotsWithExternalAccountId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Chronicle" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getContactInformation": { + "get": { + "description": "Retrieve the contact information for the brand such as the corporate or support contact. This will include the contact name, telephone number, fax number, email address, and mailing address of the contact. ", + "summary": "Retrieve the contact information for the customer account brand.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getContactInformation/", + "operationId": "SoftLayer_Brand::getContactInformation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Brand_Contact" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getMerchantName": { + "get": { + "description": "Get the payment processor merchant name.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getMerchantName/", + "operationId": "SoftLayer_Brand::getMerchantName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Brand record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getObject/", + "operationId": "SoftLayer_Brand::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getToken": { + "post": { + "description": "(DEPRECATED) Use [[SoftLayer_User_Customer::getImpersonationToken]] method. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getToken/", + "operationId": "SoftLayer_Brand::getToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/isIbmSlicBrand": { + "get": { + "description": "Check if the brand is IBM SLIC top level brand or sub brand. ", + "summary": "Check if the brand is IBM SLIC top level brand or sub brand.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/isIbmSlicBrand/", + "operationId": "SoftLayer_Brand::isIbmSlicBrand", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/isPlatformServicesBrand": { + "get": { + "description": "Check if the alternate billing system of brand is Bluemix. ", + "summary": "Check if the alternate billing system of brand is Bluemix.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/isPlatformServicesBrand/", + "operationId": "SoftLayer_Brand::isPlatformServicesBrand", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/migrateExternalAccount": { + "post": { + "description": "Will attempt to migrate an external account to the brand in context. ", + "summary": "Migrates an account from an external brand to this brand.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/migrateExternalAccount/", + "operationId": "SoftLayer_Brand::migrateExternalAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Brand_Migration_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/reactivateAccount": { + "post": { + "description": "Reactivate an account associated with this Brand. Anything that would disqualify the account from being reactivated will cause an exception to be raised. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/reactivateAccount/", + "operationId": "SoftLayer_Brand::reactivateAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/refreshBillingItemSnapshot": { + "post": { + "description": "When this service is called given an IBM Cloud infrastructure account ID owned by the calling brand, the process is started to refresh the billing item snapshots belonging to that account. This refresh is async and can take an undetermined amount of time. Even if this endpoint returns an OK, it doesn't guarantee that refresh did not fail or encounter issues. \n\n", + "summary": "Begins the process for refreshing the billing item snapshots", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/refreshBillingItemSnapshot/", + "operationId": "SoftLayer_Brand::refreshBillingItemSnapshot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/verifyCanDisableAccount": { + "post": { + "description": "Verify that an account may be disabled by a Brand Agent. Anything that would disqualify the account from being disabled will cause an exception to be raised. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/verifyCanDisableAccount/", + "operationId": "SoftLayer_Brand::verifyCanDisableAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/verifyCanReactivateAccount": { + "post": { + "description": "Verify that an account may be reactivated by a Brand Agent. Anything that would disqualify the account from being reactivated will cause an exception to be raised. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/verifyCanReactivateAccount/", + "operationId": "SoftLayer_Brand::verifyCanReactivateAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getAccount/", + "operationId": "SoftLayer_Brand::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getAllOwnedAccounts": { + "get": { + "description": "All accounts owned by the brand.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getAllOwnedAccounts/", + "operationId": "SoftLayer_Brand::getAllOwnedAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getAllowAccountCreationFlag": { + "get": { + "description": "This flag indicates if creation of accounts is allowed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getAllowAccountCreationFlag/", + "operationId": "SoftLayer_Brand::getAllowAccountCreationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getBillingItemSnapshots": { + "get": { + "description": "Returns snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getBillingItemSnapshots/", + "operationId": "SoftLayer_Brand::getBillingItemSnapshots", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Chronicle" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getBusinessPartner": { + "get": { + "description": "Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getBusinessPartner/", + "operationId": "SoftLayer_Brand::getBusinessPartner", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand_Business_Partner" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getBusinessPartnerFlag": { + "get": { + "description": "Flag indicating if the brand is a business partner.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getBusinessPartnerFlag/", + "operationId": "SoftLayer_Brand::getBusinessPartnerFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getCatalog": { + "get": { + "description": "The Product Catalog for the Brand", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getCatalog/", + "operationId": "SoftLayer_Brand::getCatalog", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Catalog" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getContacts": { + "get": { + "description": "The contacts for the brand.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getContacts/", + "operationId": "SoftLayer_Brand::getContacts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Brand_Contact" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getCustomerCountryLocationRestrictions": { + "get": { + "description": "This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getCustomerCountryLocationRestrictions/", + "operationId": "SoftLayer_Brand::getCustomerCountryLocationRestrictions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Brand_Restriction_Location_CustomerCountry" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getDistributor": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getDistributor/", + "operationId": "SoftLayer_Brand::getDistributor", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getDistributorChildFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getDistributorChildFlag/", + "operationId": "SoftLayer_Brand::getDistributorChildFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getDistributorFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getDistributorFlag/", + "operationId": "SoftLayer_Brand::getDistributorFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getHardware": { + "get": { + "description": "An account's associated hardware objects.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getHardware/", + "operationId": "SoftLayer_Brand::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getHasAgentAdvancedSupportFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getHasAgentAdvancedSupportFlag/", + "operationId": "SoftLayer_Brand::getHasAgentAdvancedSupportFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getHasAgentSupportFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getHasAgentSupportFlag/", + "operationId": "SoftLayer_Brand::getHasAgentSupportFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getOpenTickets": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getOpenTickets/", + "operationId": "SoftLayer_Brand::getOpenTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getOwnedAccounts": { + "get": { + "description": "Active accounts owned by the brand.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getOwnedAccounts/", + "operationId": "SoftLayer_Brand::getOwnedAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getSecurityLevel": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getSecurityLevel/", + "operationId": "SoftLayer_Brand::getSecurityLevel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Security_Level" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getTicketGroups": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getTicketGroups/", + "operationId": "SoftLayer_Brand::getTicketGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getTickets": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getTickets/", + "operationId": "SoftLayer_Brand::getTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getUsers": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getUsers/", + "operationId": "SoftLayer_Brand::getUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand/{SoftLayer_BrandID}/getVirtualGuests": { + "get": { + "description": "An account's associated virtual guest objects.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand/getVirtualGuests/", + "operationId": "SoftLayer_Brand::getVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand_Business_Partner/{SoftLayer_Brand_Business_PartnerID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Brand_Business_Partner record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand_Business_Partner/getObject/", + "operationId": "SoftLayer_Brand_Business_Partner::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand_Business_Partner" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand_Business_Partner/{SoftLayer_Brand_Business_PartnerID}/getBrand": { + "get": { + "description": "Brand associated with the business partner data", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand_Business_Partner/getBrand/", + "operationId": "SoftLayer_Brand_Business_Partner::getBrand", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand_Business_Partner/{SoftLayer_Brand_Business_PartnerID}/getChannel": { + "get": { + "description": "Channel indicator used to categorize business partner revenue.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand_Business_Partner/getChannel/", + "operationId": "SoftLayer_Brand_Business_Partner::getChannel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Business_Partner_Channel" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand_Business_Partner/{SoftLayer_Brand_Business_PartnerID}/getSegment": { + "get": { + "description": "Segment indicator used to categorize business partner revenue.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand_Business_Partner/getSegment/", + "operationId": "SoftLayer_Brand_Business_Partner::getSegment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Business_Partner_Segment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand_Restriction_Location_CustomerCountry/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getAllObjects/", + "operationId": "SoftLayer_Brand_Restriction_Location_CustomerCountry::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Brand_Restriction_Location_CustomerCountry" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand_Restriction_Location_CustomerCountry/{SoftLayer_Brand_Restriction_Location_CustomerCountryID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Brand_Restriction_Location_CustomerCountry record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getObject/", + "operationId": "SoftLayer_Brand_Restriction_Location_CustomerCountry::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand_Restriction_Location_CustomerCountry" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand_Restriction_Location_CustomerCountry/{SoftLayer_Brand_Restriction_Location_CustomerCountryID}/getBrand": { + "get": { + "description": "This references the brand that has a brand-location-country restriction setup.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getBrand/", + "operationId": "SoftLayer_Brand_Restriction_Location_CustomerCountry::getBrand", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Brand" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Brand_Restriction_Location_CustomerCountry/{SoftLayer_Brand_Restriction_Location_CustomerCountryID}/getLocation": { + "get": { + "description": "This references the datacenter that has a brand-location-country restriction setup. For example, if a datacenter is listed with a restriction for Canada, a Canadian customer may not be eligible to order services at that location.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getLocation/", + "operationId": "SoftLayer_Brand_Restriction_Location_CustomerCountry::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Business_Partner_Channel/{SoftLayer_Business_Partner_ChannelID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Business_Partner_Channel record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Business_Partner_Channel/getObject/", + "operationId": "SoftLayer_Business_Partner_Channel::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Business_Partner_Channel" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Business_Partner_Segment/{SoftLayer_Business_Partner_SegmentID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Business_Partner_Segment record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Business_Partner_Segment/getObject/", + "operationId": "SoftLayer_Business_Partner_Segment::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Business_Partner_Segment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Catalyst_Company_Type/getAllObjects": { + "get": { + "description": "<<.create_object > li > div { padding-top: .5em; padding-bottom: .5em} \ncreateObject() enables the creation of servers on an account. This \nmethod is a simplified alternative to interacting with the ordering system directly. \n\n\nIn order to create a server, a template object must be sent in with a few required \nvalues. \n\n\nWhen this method returns an order will have been placed for a server of the specified configuration. \n\n\nTo determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]], \nchecking the 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 \n
    Hostname for the server.
      \n
    • Required
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
  • domain \n
    Domain for the server.
      \n
    • Required
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
  • processorCoreAmount \n
    The number of logical CPU cores to allocate.
      \n
    • Required
      • \n
    • Type - int
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n
    \n
    • \n
  • memoryCapacity \n
    The amount of memory to allocate in gigabytes.
      \n
    • Required
      • \n
    • Type - int
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n
    \n
    • \n
  • hourlyBillingFlag \n
    Specifies 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
    • \n
  • operatingSystemReferenceCode \n
    An 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
    • \n
  • datacenter.name \n
    Specifies which datacenter the server is to be provisioned in.
      \n
    • Required
      • \n
    • Type - string
      • \n
    • The datacenter property is a [[SoftLayer_Location (type)|location]] structure with the name field set.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"datacenter\": { \n \"name\": \"dal05\" \n } \n} \n
    \n
    • \n
  • networkComponents.maxSpeed \n
    Specifies 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 networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The maxSpeed property 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 { \n \"networkComponents\": [ \n { \n \"maxSpeed\": 1000 \n } \n ] \n} \n
    \n
    • \n
  • networkComponents.redundancyEnabledFlag \n
    Specifies whether or not the server's network components should be in redundancy groups.
      \n
    • Optional
      • \n
    • Type - bool
      • \n
    • Default - false
      • \n
    • Description - The networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the redundancyEnabledFlag property is true the server's network components will be in redundancy groups.
      • \n
    \n { \n \"networkComponents\": [ \n { \n \"redundancyEnabledFlag\": false \n } \n ] \n} \n
    \n
    • \n
  • privateNetworkOnlyFlag \n
    Specifies 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
    • \n
  • primaryNetworkComponent.networkVlan.id \n
    Specifies the network vlan which is to be used for the frontend interface of the server.
      \n
    • Optional
      • \n
    • Type - int
      • \n
    • Description - The primaryNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the frontend network vlan of the server.
      • \n
    \n { \n \"primaryNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 1 \n } \n } \n} \n
    \n
    • \n
  • primaryBackendNetworkComponent.networkVlan.id \n
    Specifies the network vlan which is to be used for the backend interface of the server.
      \n
    • Optional
      • \n
    • Type - int
      • \n
    • Description - The primaryBackendNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the backend network vlan of the server.
      • \n
    \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 fixedConfigurationPreset property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The keyName property must be set to specify preset to use.
      • \n
    • If a fixed configuration preset is used processorCoreAmount, memoryCapacity and hardDrives properties must not be set.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"fixedConfigurationPreset\": { \n \"keyName\": \"SOME_KEY_NAME\" \n } \n} \n
    \n
    • \n
  • userData.value \n
    Arbitrary data to be made available to the server.
      \n
    • Optional
      • \n
    • Type - string
      • \n
    • Description - The userData property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the value property 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 { \n \"userData\": [ \n { \n \"value\": \"someValue\" \n } \n ] \n} \n
    \n
    • \n
  • hardDrives \n
    Hard 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 hardDrives property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures. \n
    • Each hard drive must specify the capacity property.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"hardDrives\": [ \n { \n \"capacity\": 500 \n } \n ] \n} \n
    \n
    • \n
  • sshKeys \n
    SSH 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 sshKeys property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the id property 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 { \n \"sshKeys\": [ \n { \n \"id\": 123 \n } \n ] \n} \n
    \n
    • \n
  • postInstallScriptUri \n
    Specifies the uri location of the script to be downloaded and run after installation is complete.
      \n
    • Optional
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
\n\n\n

REST Example

\ncurl -X POST -d '{ \n \"parameters\":[ \n { \n \"hostname\": \"host1\", \n \"domain\": \"example.com\", \n \"processorCoreAmount\": 2, \n \"memoryCapacity\": 2, \n \"hourlyBillingFlag\": true, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\" \n } \n ] \n}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json \n \nHTTP/1.1 201 Created \nLocation: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject \n\n\n{ \n \"accountId\": 232298, \n \"bareMetalInstanceFlag\": null, \n \"domain\": \"example.com\", \n \"hardwareStatusId\": null, \n \"hostname\": \"host1\", \n \"id\": null, \n \"serviceProviderId\": null, \n \"serviceProviderResourceId\": null, \n \"globalIdentifier\": \"f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5\", \n \"hourlyBillingFlag\": true, \n \"memoryCapacity\": 2, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\", \n \"processorCoreAmount\": 2 \n} \n ", + "summary": "Create a new server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/createObject/", + "operationId": "SoftLayer_Hardware::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/deleteObject": { + "get": { + "description": "\nThis method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns. ", + "summary": "Delete a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/deleteObject/", + "operationId": "SoftLayer_Hardware::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/deleteSoftwareComponentPasswords": { + "post": { + "description": "Delete software component passwords. ", + "summary": "Delete software component passwords.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/deleteSoftwareComponentPasswords/", + "operationId": "SoftLayer_Hardware::deleteSoftwareComponentPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/deleteTag": { + "post": { + "description": "Delete an existing tag. If there are any references on the tag, an exception will be thrown. ", + "summary": "Delete a tag", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/deleteTag/", + "operationId": "SoftLayer_Hardware::deleteTag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/editSoftwareComponentPasswords": { + "post": { + "description": "Edit the properties of a software component password such as the username, password, and notes. ", + "summary": "Edit the properties of software component passwords.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/editSoftwareComponentPasswords/", + "operationId": "SoftLayer_Hardware::editSoftwareComponentPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/executeRemoteScript": { + "post": { + "description": "Download and run remote script from uri on the hardware.", + "summary": "Download and run remote script from uri on the hardware. Requires https for script to be executed after download. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/executeRemoteScript/", + "operationId": "SoftLayer_Hardware::executeRemoteScript", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/findByIpAddress": { + "post": { + "description": "The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned. ", + "summary": "Find hardware by its primary public or private IP (ipv4) address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/findByIpAddress/", + "operationId": "SoftLayer_Hardware::findByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/generateOrderTemplate": { + "post": { + "description": "\nObtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]]. \n\n\nThis is primarily useful when there is a necessity to confirm the price which will be charged for an order. \n\n\nSee [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter. ", + "summary": "Obtain an order container for a given template object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/generateOrderTemplate/", + "operationId": "SoftLayer_Hardware::generateOrderTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAttachedNetworkStorages": { + "post": { + "description": "This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAttachedNetworkStorages/", + "operationId": "SoftLayer_Hardware::getAttachedNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAvailableBillingTermChangePrices": { + "get": { + "description": "Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers. ", + "summary": "Retrieves a list of available term prices available to this of hardware. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAvailableBillingTermChangePrices/", + "operationId": "SoftLayer_Hardware::getAvailableBillingTermChangePrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAvailableNetworkStorages": { + "post": { + "description": "This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAvailableNetworkStorages/", + "operationId": "SoftLayer_Hardware::getAvailableNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBackendIncomingBandwidth": { + "post": { + "description": "The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes. ", + "summary": "Retrieve the amount of incoming private network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBackendIncomingBandwidth/", + "operationId": "SoftLayer_Hardware::getBackendIncomingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBackendOutgoingBandwidth": { + "post": { + "description": "The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes. ", + "summary": "Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBackendOutgoingBandwidth/", + "operationId": "SoftLayer_Hardware::getBackendOutgoingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getComponentDetailsXML": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getComponentDetailsXML/", + "operationId": "SoftLayer_Hardware::getComponentDetailsXML", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/getCreateObjectOptions": { + "get": { + "description": "\nThere are many options that may be provided while ordering a server, this method can be used to determine what these options are. \n\n\nDetailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]]. ", + "summary": "Determine options available when creating a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getCreateObjectOptions/", + "operationId": "SoftLayer_Hardware::getCreateObjectOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Configuration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getCurrentBillingDetail": { + "get": { + "description": "Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage. ", + "summary": "<< EOT", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getCurrentBillingDetail/", + "operationId": "SoftLayer_Hardware::getCurrentBillingDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getCurrentBillingTotal": { + "get": { + "description": "Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware. ", + "summary": "Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getCurrentBillingTotal/", + "operationId": "SoftLayer_Hardware::getCurrentBillingTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDailyAverage": { + "post": { + "description": "The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day. ", + "summary": "calculate the average daily network traffic used by a server in gigabytes.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDailyAverage/", + "operationId": "SoftLayer_Hardware::getDailyAverage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getFrontendIncomingBandwidth": { + "post": { + "description": "The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB). ", + "summary": "Retrieve the amount of incoming public network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getFrontendIncomingBandwidth/", + "operationId": "SoftLayer_Hardware::getFrontendIncomingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getFrontendOutgoingBandwidth": { + "post": { + "description": "The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB). ", + "summary": "Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getFrontendOutgoingBandwidth/", + "operationId": "SoftLayer_Hardware::getFrontendOutgoingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getHourlyBandwidth": { + "post": { + "description": "The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of \n\n'02/01/2008 0:00' \n\nresults in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time). \n\nFor data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware. ", + "summary": "Retrieves bandwidth hourly over a 24-hour period for the specified hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getHourlyBandwidth/", + "operationId": "SoftLayer_Hardware::getHourlyBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve the account that your portal user is assigned to. ", + "summary": "Retrieve a SoftLayer_Hardware record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getObject/", + "operationId": "SoftLayer_Hardware::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getPrivateBandwidthData": { + "post": { + "description": "Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. ", + "summary": "Retrieve a graph of a server's private network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getPrivateBandwidthData/", + "operationId": "SoftLayer_Hardware::getPrivateBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getPublicBandwidthData": { + "post": { + "description": "Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. ", + "summary": "Retrieve a graph of a server's public network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getPublicBandwidthData/", + "operationId": "SoftLayer_Hardware::getPublicBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getSensorData": { + "get": { + "description": "The '''getSensorData''' method retrieves a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures various information, including system temperatures, voltages and other local server settings. Sensor data is cached for 30 second; calls made to this method for the same server within 30 seconds of each other will result in the same data being returned. To ensure that the data retrieved retrieves snapshot of varied data, make calls greater than 30 seconds apart. ", + "summary": "Retrieve a server's hardware state via its internal sensors", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getSensorData/", + "operationId": "SoftLayer_Hardware::getSensorData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_SensorReading" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getSensorDataWithGraphs": { + "get": { + "description": "The '''getSensorDataWithGraphs''' method retrieves the raw data returned from the server's remote management card. Along with raw data, graphs for the CPU and system temperatures and fan speeds are also returned. For more details on what information is returned, refer to the ''getSensorData'' method. ", + "summary": "Retrieve server's temperature and fan speed graphs as well the sensor raw data.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getSensorDataWithGraphs/", + "operationId": "SoftLayer_Hardware::getSensorDataWithGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getServerFanSpeedGraphs": { + "get": { + "description": "The '''getServerFanSpeedGraphs''' method retrieves the server's fan speeds and displays the speeds using tachometer graphs. data used to construct these graphs is retrieved from the server's remote management card. Each graph returned will have an associated title. ", + "summary": "Retrieve a server's fan speed graphs.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getServerFanSpeedGraphs/", + "operationId": "SoftLayer_Hardware::getServerFanSpeedGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getServerPowerState": { + "get": { + "description": "The '''getPowerState''' method retrieves the power state for the selected server. The server's power status is retrieved from its remote management card. This method returns \"on\", for a server that has been powered on, or \"off\" for servers powered off. ", + "summary": "Retrieves a server's power state.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getServerPowerState/", + "operationId": "SoftLayer_Hardware::getServerPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getServerTemperatureGraphs": { + "get": { + "description": "The '''getServerTemperatureGraphs''' retrieves the server's temperatures and displays the various temperatures using thermometer graphs. Temperatures retrieved are CPU temperature(s) and system temperatures. Data used to construct the graphs is retrieved from the server's remote management card. All graphs returned will have an associated title. ", + "summary": "Retrieve server's temperature graphs", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getServerTemperatureGraphs/", + "operationId": "SoftLayer_Hardware::getServerTemperatureGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getTransactionHistory": { + "get": { + "description": "\nThis method will query transaction history for a piece of hardware. ", + "summary": "Get transaction history for a piece of hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getTransactionHistory/", + "operationId": "SoftLayer_Hardware::getTransactionHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getUpgradeItemPrices": { + "get": { + "description": "Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs. ", + "summary": "Retrieve a list of upgradeable items available to a piece of hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getUpgradeItemPrices/", + "operationId": "SoftLayer_Hardware::getUpgradeItemPrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/importVirtualHost": { + "get": { + "description": "The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.", + "summary": "attempt to import the host record for the virtualization platform running on a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/importVirtualHost/", + "operationId": "SoftLayer_Hardware::importVirtualHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/isPingable": { + "get": { + "description": "The '''isPingable''' method issues a ping command to the selected server and returns the result of the ping command. This boolean return value displays ''true'' upon successful ping or ''false'' for a failed ping. ", + "summary": "Verifies whether or not a server is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/isPingable/", + "operationId": "SoftLayer_Hardware::isPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/ping": { + "get": { + "description": "Issues a ping command to the server and returns the ping response. ", + "summary": "Issues ping command.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/ping/", + "operationId": "SoftLayer_Hardware::ping", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/powerCycle": { + "get": { + "description": "The '''powerCycle''' method completes a power off and power on of the server successively in one command. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. '''This method should only be used when all other options have been exhausted'''. Additional remote management commands may not be executed if this command was successfully issued within the last 20 minutes to avoid server failure. Remote management commands include: \n\nrebootSoft rebootHard powerOn powerOff powerCycle \n\n", + "summary": "Issues power cycle to server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/powerCycle/", + "operationId": "SoftLayer_Hardware::powerCycle", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/powerOff": { + "get": { + "description": "This method will power off the server via the server's remote management card. ", + "summary": "Power off server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/powerOff/", + "operationId": "SoftLayer_Hardware::powerOff", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/powerOn": { + "get": { + "description": "The '''powerOn''' method powers on a server via its remote management card. This boolean return value returns ''true'' upon successful execution and ''false'' if unsuccessful. Other remote management commands may not be issued in this command was successfully completed within the last 20 minutes to avoid server failure. Remote management commands include: \n\nrebootSoft rebootHard powerOn powerOff powerCycle \n\n", + "summary": "Power on server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/powerOn/", + "operationId": "SoftLayer_Hardware::powerOn", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/rebootDefault": { + "get": { + "description": "The '''rebootDefault''' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card. if the reset attempt is unsuccessful, a power cycle command will be issued via the power strip. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. If the reset was successful within the last 20 minutes, another remote management command cannot be completed to avoid server failure. Remote management commands include: \n\nrebootSoft rebootHard powerOn powerOff powerCycle \n\n", + "summary": "Reboot the server via the default method.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/rebootDefault/", + "operationId": "SoftLayer_Hardware::rebootDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/rebootHard": { + "get": { + "description": "The '''rebootHard''' method reboots the server by issuing a cycle command to the server's remote management card. A hard reboot is equivalent to pressing the ''Reset'' button on a server - it is issued immediately and will not allow processes to shut down prior to the reboot. Completing a hard reboot may initiate system disk checks upon server reboot, causing the boot up to take longer than normally expected. \n\nRemote management commands are unable to be executed if a reboot has been issued successfully within the last 20 minutes to avoid server failure. Remote management commands include: \n\nrebootSoft rebootHard powerOn powerOff powerCycle \n\n", + "summary": "Reboot the server via \"hard\" reboot.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/rebootHard/", + "operationId": "SoftLayer_Hardware::rebootHard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/rebootSoft": { + "get": { + "description": "The '''rebootSoft''' method reboots the server by issuing a reset command to the server's remote management card via soft reboot. When executing a soft reboot, servers allow all processes to shut down completely before rebooting. Remote management commands are unable to be issued within 20 minutes of issuing a successful soft reboot in order to avoid server failure. Remote management commands include: \n\nrebootSoft rebootHard powerOn powerOff powerCycle \n\n", + "summary": "Execute a soft reboot to the server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/rebootSoft/", + "operationId": "SoftLayer_Hardware::rebootSoft", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/refreshDeviceStatus": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/refreshDeviceStatus/", + "operationId": "SoftLayer_Hardware::refreshDeviceStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/removeAccessToNetworkStorage": { + "post": { + "description": "This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control. ", + "summary": "Remove access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorage/", + "operationId": "SoftLayer_Hardware::removeAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/removeAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Remove access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorageList/", + "operationId": "SoftLayer_Hardware::removeAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/removeTags": { + "post": { + "description": null, + "summary": "Remove a tag reference", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/removeTags/", + "operationId": "SoftLayer_Hardware::removeTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/setTags": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/setTags/", + "operationId": "SoftLayer_Hardware::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/updateIpmiPassword": { + "post": { + "description": "This method will update the root IPMI password on this SoftLayer_Hardware. ", + "summary": "Update the root IPMI user password ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/updateIpmiPassword/", + "operationId": "SoftLayer_Hardware::updateIpmiPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAccount": { + "get": { + "description": "The account associated with a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAccount/", + "operationId": "SoftLayer_Hardware::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getActiveComponents": { + "get": { + "description": "A piece of hardware's active physical components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getActiveComponents/", + "operationId": "SoftLayer_Hardware::getActiveComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getActiveNetworkMonitorIncident": { + "get": { + "description": "A piece of hardware's active network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getActiveNetworkMonitorIncident/", + "operationId": "SoftLayer_Hardware::getActiveNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAllPowerComponents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAllPowerComponents/", + "operationId": "SoftLayer_Hardware::getAllPowerComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Power_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAllowedHost": { + "get": { + "description": "The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAllowedHost/", + "operationId": "SoftLayer_Hardware::getAllowedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAllowedNetworkStorage": { + "get": { + "description": "The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAllowedNetworkStorage/", + "operationId": "SoftLayer_Hardware::getAllowedNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAllowedNetworkStorageReplicas": { + "get": { + "description": "The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAllowedNetworkStorageReplicas/", + "operationId": "SoftLayer_Hardware::getAllowedNetworkStorageReplicas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAntivirusSpywareSoftwareComponent": { + "get": { + "description": "Information regarding an antivirus/spyware software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAntivirusSpywareSoftwareComponent/", + "operationId": "SoftLayer_Hardware::getAntivirusSpywareSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAttributes": { + "get": { + "description": "Information regarding a piece of hardware's specific attributes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAttributes/", + "operationId": "SoftLayer_Hardware::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getAverageDailyPublicBandwidthUsage": { + "get": { + "description": "The average daily public bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getAverageDailyPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware::getAverageDailyPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBackendNetworkComponents": { + "get": { + "description": "A piece of hardware's back-end or private network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBackendNetworkComponents/", + "operationId": "SoftLayer_Hardware::getBackendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBackendRouters": { + "get": { + "description": "A hardware's backend or private router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBackendRouters/", + "operationId": "SoftLayer_Hardware::getBackendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBandwidthAllocation": { + "get": { + "description": "A hardware's allotted bandwidth (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBandwidthAllocation/", + "operationId": "SoftLayer_Hardware::getBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBandwidthAllotmentDetail": { + "get": { + "description": "A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBandwidthAllotmentDetail/", + "operationId": "SoftLayer_Hardware::getBandwidthAllotmentDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBenchmarkCertifications": { + "get": { + "description": "Information regarding a piece of hardware's benchmark certifications.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBenchmarkCertifications/", + "operationId": "SoftLayer_Hardware::getBenchmarkCertifications", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Benchmark_Certification" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBillingItem": { + "get": { + "description": "Information regarding the billing item for a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBillingItem/", + "operationId": "SoftLayer_Hardware::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBillingItemFlag": { + "get": { + "description": "A flag indicating that a billing item exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBillingItemFlag/", + "operationId": "SoftLayer_Hardware::getBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBlockCancelBecauseDisconnectedFlag": { + "get": { + "description": "Determines whether the hardware is ineligible for cancellation because it is disconnected.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBlockCancelBecauseDisconnectedFlag/", + "operationId": "SoftLayer_Hardware::getBlockCancelBecauseDisconnectedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getBusinessContinuanceInsuranceFlag": { + "get": { + "description": "Status indicating whether or not a piece of hardware has business continuance insurance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getBusinessContinuanceInsuranceFlag/", + "operationId": "SoftLayer_Hardware::getBusinessContinuanceInsuranceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getChildrenHardware": { + "get": { + "description": "Child hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getChildrenHardware/", + "operationId": "SoftLayer_Hardware::getChildrenHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getComponents": { + "get": { + "description": "A piece of hardware's components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getComponents/", + "operationId": "SoftLayer_Hardware::getComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getContinuousDataProtectionSoftwareComponent": { + "get": { + "description": "A continuous data protection/server backup software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getContinuousDataProtectionSoftwareComponent/", + "operationId": "SoftLayer_Hardware::getContinuousDataProtectionSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getCurrentBillableBandwidthUsage": { + "get": { + "description": "The current billable public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getCurrentBillableBandwidthUsage/", + "operationId": "SoftLayer_Hardware::getCurrentBillableBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDatacenter": { + "get": { + "description": "Information regarding the datacenter in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDatacenter/", + "operationId": "SoftLayer_Hardware::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDatacenterName": { + "get": { + "description": "The name of the datacenter in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDatacenterName/", + "operationId": "SoftLayer_Hardware::getDatacenterName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDaysInSparePool": { + "get": { + "description": "Number of day(s) a server have been in spare pool.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDaysInSparePool/", + "operationId": "SoftLayer_Hardware::getDaysInSparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownlinkHardware": { + "get": { + "description": "All hardware that has uplink network connections to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDownlinkHardware/", + "operationId": "SoftLayer_Hardware::getDownlinkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownlinkNetworkHardware": { + "get": { + "description": "All hardware that has uplink network connections to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDownlinkNetworkHardware/", + "operationId": "SoftLayer_Hardware::getDownlinkNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownlinkServers": { + "get": { + "description": "Information regarding all servers attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDownlinkServers/", + "operationId": "SoftLayer_Hardware::getDownlinkServers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownlinkVirtualGuests": { + "get": { + "description": "Information regarding all virtual guests attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDownlinkVirtualGuests/", + "operationId": "SoftLayer_Hardware::getDownlinkVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownstreamHardwareBindings": { + "get": { + "description": "All hardware downstream from a network device.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDownstreamHardwareBindings/", + "operationId": "SoftLayer_Hardware::getDownstreamHardwareBindings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Uplink_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownstreamNetworkHardware": { + "get": { + "description": "All network hardware downstream from the selected piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardware/", + "operationId": "SoftLayer_Hardware::getDownstreamNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownstreamNetworkHardwareWithIncidents": { + "get": { + "description": "All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardwareWithIncidents/", + "operationId": "SoftLayer_Hardware::getDownstreamNetworkHardwareWithIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownstreamServers": { + "get": { + "description": "Information regarding all servers attached downstream to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDownstreamServers/", + "operationId": "SoftLayer_Hardware::getDownstreamServers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownstreamVirtualGuests": { + "get": { + "description": "Information regarding all virtual guests attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDownstreamVirtualGuests/", + "operationId": "SoftLayer_Hardware::getDownstreamVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getDriveControllers": { + "get": { + "description": "The drive controllers contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getDriveControllers/", + "operationId": "SoftLayer_Hardware::getDriveControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getEvaultNetworkStorage": { + "get": { + "description": "Information regarding a piece of hardware's associated EVault network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getEvaultNetworkStorage/", + "operationId": "SoftLayer_Hardware::getEvaultNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getFirewallServiceComponent": { + "get": { + "description": "Information regarding a piece of hardware's firewall services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getFirewallServiceComponent/", + "operationId": "SoftLayer_Hardware::getFirewallServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getFixedConfigurationPreset": { + "get": { + "description": "Defines the fixed components in a fixed configuration bare metal server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getFixedConfigurationPreset/", + "operationId": "SoftLayer_Hardware::getFixedConfigurationPreset", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getFrontendNetworkComponents": { + "get": { + "description": "A piece of hardware's front-end or public network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getFrontendNetworkComponents/", + "operationId": "SoftLayer_Hardware::getFrontendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getFrontendRouters": { + "get": { + "description": "A hardware's frontend or public router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getFrontendRouters/", + "operationId": "SoftLayer_Hardware::getFrontendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getFutureBillingItem": { + "get": { + "description": "Information regarding the future billing item for a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getFutureBillingItem/", + "operationId": "SoftLayer_Hardware::getFutureBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getGlobalIdentifier": { + "get": { + "description": "A hardware's universally unique identifier.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getGlobalIdentifier/", + "operationId": "SoftLayer_Hardware::getGlobalIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getHardDrives": { + "get": { + "description": "The hard drives contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getHardDrives/", + "operationId": "SoftLayer_Hardware::getHardDrives", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getHardwareChassis": { + "get": { + "description": "The chassis that a piece of hardware is housed in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getHardwareChassis/", + "operationId": "SoftLayer_Hardware::getHardwareChassis", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Chassis" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getHardwareFunction": { + "get": { + "description": "A hardware's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getHardwareFunction/", + "operationId": "SoftLayer_Hardware::getHardwareFunction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Function" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getHardwareFunctionDescription": { + "get": { + "description": "A hardware's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getHardwareFunctionDescription/", + "operationId": "SoftLayer_Hardware::getHardwareFunctionDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getHardwareState": { + "get": { + "description": "A hardware's power/transaction state.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getHardwareState/", + "operationId": "SoftLayer_Hardware::getHardwareState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getHardwareStatus": { + "get": { + "description": "A hardware's status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getHardwareStatus/", + "operationId": "SoftLayer_Hardware::getHardwareStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getHasTrustedPlatformModuleBillingItemFlag": { + "get": { + "description": "Determine in hardware object has TPM enabled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getHasTrustedPlatformModuleBillingItemFlag/", + "operationId": "SoftLayer_Hardware::getHasTrustedPlatformModuleBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getHostIpsSoftwareComponent": { + "get": { + "description": "Information regarding a host IPS software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getHostIpsSoftwareComponent/", + "operationId": "SoftLayer_Hardware::getHostIpsSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getHourlyBillingFlag": { + "get": { + "description": "A server's hourly billing status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getHourlyBillingFlag/", + "operationId": "SoftLayer_Hardware::getHourlyBillingFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getInboundBandwidthUsage": { + "get": { + "description": "The sum of all the inbound network traffic data for the last 30 days.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getInboundBandwidthUsage/", + "operationId": "SoftLayer_Hardware::getInboundBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getInboundPublicBandwidthUsage": { + "get": { + "description": "The total public inbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getInboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware::getInboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getIsBillingTermChangeAvailableFlag": { + "get": { + "description": "Whether or not this hardware object is eligible to change to term billing.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getIsBillingTermChangeAvailableFlag/", + "operationId": "SoftLayer_Hardware::getIsBillingTermChangeAvailableFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getIsCloudReadyNodeCertified": { + "get": { + "description": "Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getIsCloudReadyNodeCertified/", + "operationId": "SoftLayer_Hardware::getIsCloudReadyNodeCertified", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getLastTransaction": { + "get": { + "description": "Information regarding the last transaction a server performed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getLastTransaction/", + "operationId": "SoftLayer_Hardware::getLastTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getLatestNetworkMonitorIncident": { + "get": { + "description": "A piece of hardware's latest network monitoring incident.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getLatestNetworkMonitorIncident/", + "operationId": "SoftLayer_Hardware::getLatestNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getLocation": { + "get": { + "description": "Where a piece of hardware is located within SoftLayer's location hierarchy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getLocation/", + "operationId": "SoftLayer_Hardware::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getLocationPathString": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getLocationPathString/", + "operationId": "SoftLayer_Hardware::getLocationPathString", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getLockboxNetworkStorage": { + "get": { + "description": "Information regarding a lockbox account associated with a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getLockboxNetworkStorage/", + "operationId": "SoftLayer_Hardware::getLockboxNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getManagedResourceFlag": { + "get": { + "description": "A flag indicating that the hardware is a managed resource.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getManagedResourceFlag/", + "operationId": "SoftLayer_Hardware::getManagedResourceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getMemory": { + "get": { + "description": "Information regarding a piece of hardware's memory.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getMemory/", + "operationId": "SoftLayer_Hardware::getMemory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getMemoryCapacity": { + "get": { + "description": "The amount of memory a piece of hardware has, measured in gigabytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getMemoryCapacity/", + "operationId": "SoftLayer_Hardware::getMemoryCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getMetricTrackingObject": { + "get": { + "description": "A piece of hardware's metric tracking object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getMetricTrackingObject/", + "operationId": "SoftLayer_Hardware::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getModules": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getModules/", + "operationId": "SoftLayer_Hardware::getModules", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getMonitoringRobot": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getMonitoringRobot/", + "operationId": "SoftLayer_Hardware::getMonitoringRobot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Monitoring_Robot" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getMonitoringServiceComponent": { + "get": { + "description": "Information regarding a piece of hardware's network monitoring services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getMonitoringServiceComponent/", + "operationId": "SoftLayer_Hardware::getMonitoringServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getMonitoringServiceEligibilityFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getMonitoringServiceEligibilityFlag/", + "operationId": "SoftLayer_Hardware::getMonitoringServiceEligibilityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getMotherboard": { + "get": { + "description": "Information regarding a piece of hardware's motherboard.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getMotherboard/", + "operationId": "SoftLayer_Hardware::getMotherboard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkCards": { + "get": { + "description": "Information regarding a piece of hardware's network cards.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkCards/", + "operationId": "SoftLayer_Hardware::getNetworkCards", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkComponents": { + "get": { + "description": "Returns a hardware's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkComponents/", + "operationId": "SoftLayer_Hardware::getNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkGatewayMember": { + "get": { + "description": "The gateway member if this device is part of a network gateway.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkGatewayMember/", + "operationId": "SoftLayer_Hardware::getNetworkGatewayMember", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkGatewayMemberFlag": { + "get": { + "description": "Whether or not this device is part of a network gateway.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkGatewayMemberFlag/", + "operationId": "SoftLayer_Hardware::getNetworkGatewayMemberFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkManagementIpAddress": { + "get": { + "description": "A piece of hardware's network management IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkManagementIpAddress/", + "operationId": "SoftLayer_Hardware::getNetworkManagementIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkMonitorAttachedDownHardware": { + "get": { + "description": "All servers with failed monitoring that are attached downstream to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownHardware/", + "operationId": "SoftLayer_Hardware::getNetworkMonitorAttachedDownHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkMonitorAttachedDownVirtualGuests": { + "get": { + "description": "Virtual guests that are attached downstream to a hardware that have failed monitoring", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownVirtualGuests/", + "operationId": "SoftLayer_Hardware::getNetworkMonitorAttachedDownVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkMonitorIncidents": { + "get": { + "description": "The status of all of a piece of hardware's network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkMonitorIncidents/", + "operationId": "SoftLayer_Hardware::getNetworkMonitorIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkMonitors": { + "get": { + "description": "Information regarding a piece of hardware's network monitors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkMonitors/", + "operationId": "SoftLayer_Hardware::getNetworkMonitors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkStatus": { + "get": { + "description": "The value of a hardware's network status attribute. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkStatus/", + "operationId": "SoftLayer_Hardware::getNetworkStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkStatusAttribute": { + "get": { + "description": "The hardware's related network status attribute. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkStatusAttribute/", + "operationId": "SoftLayer_Hardware::getNetworkStatusAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkStorage": { + "get": { + "description": "Information regarding a piece of hardware's associated network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkStorage/", + "operationId": "SoftLayer_Hardware::getNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkVlans": { + "get": { + "description": "The network virtual LANs (VLANs) associated with a piece of hardware's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNetworkVlans/", + "operationId": "SoftLayer_Hardware::getNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNextBillingCycleBandwidthAllocation": { + "get": { + "description": "A hardware's allotted bandwidth for the next billing cycle (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNextBillingCycleBandwidthAllocation/", + "operationId": "SoftLayer_Hardware::getNextBillingCycleBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNotesHistory": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNotesHistory/", + "operationId": "SoftLayer_Hardware::getNotesHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Note" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNvRamCapacity": { + "get": { + "description": "The amount of non-volatile memory a piece of hardware has, measured in gigabytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNvRamCapacity/", + "operationId": "SoftLayer_Hardware::getNvRamCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getNvRamComponentModels": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getNvRamComponentModels/", + "operationId": "SoftLayer_Hardware::getNvRamComponentModels", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getOperatingSystem": { + "get": { + "description": "Information regarding a piece of hardware's operating system.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getOperatingSystem/", + "operationId": "SoftLayer_Hardware::getOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_OperatingSystem" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getOperatingSystemReferenceCode": { + "get": { + "description": "A hardware's operating system software description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getOperatingSystemReferenceCode/", + "operationId": "SoftLayer_Hardware::getOperatingSystemReferenceCode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getOutboundBandwidthUsage": { + "get": { + "description": "The sum of all the outbound network traffic data for the last 30 days.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getOutboundBandwidthUsage/", + "operationId": "SoftLayer_Hardware::getOutboundBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getOutboundPublicBandwidthUsage": { + "get": { + "description": "The total public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getOutboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware::getOutboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getParentBay": { + "get": { + "description": "Blade Bay", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getParentBay/", + "operationId": "SoftLayer_Hardware::getParentBay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Blade" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getParentHardware": { + "get": { + "description": "Parent Hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getParentHardware/", + "operationId": "SoftLayer_Hardware::getParentHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getPointOfPresenceLocation": { + "get": { + "description": "Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getPointOfPresenceLocation/", + "operationId": "SoftLayer_Hardware::getPointOfPresenceLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getPowerComponents": { + "get": { + "description": "The power components for a hardware object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getPowerComponents/", + "operationId": "SoftLayer_Hardware::getPowerComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Power_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getPowerSupply": { + "get": { + "description": "Information regarding a piece of hardware's power supply.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getPowerSupply/", + "operationId": "SoftLayer_Hardware::getPowerSupply", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getPrimaryBackendIpAddress": { + "get": { + "description": "The hardware's primary private IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getPrimaryBackendIpAddress/", + "operationId": "SoftLayer_Hardware::getPrimaryBackendIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getPrimaryBackendNetworkComponent": { + "get": { + "description": "Information regarding the hardware's primary back-end network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getPrimaryBackendNetworkComponent/", + "operationId": "SoftLayer_Hardware::getPrimaryBackendNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getPrimaryIpAddress": { + "get": { + "description": "The hardware's primary public IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getPrimaryIpAddress/", + "operationId": "SoftLayer_Hardware::getPrimaryIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getPrimaryNetworkComponent": { + "get": { + "description": "Information regarding the hardware's primary public network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getPrimaryNetworkComponent/", + "operationId": "SoftLayer_Hardware::getPrimaryNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getPrivateNetworkOnlyFlag": { + "get": { + "description": "Whether the hardware only has access to the private network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getPrivateNetworkOnlyFlag/", + "operationId": "SoftLayer_Hardware::getPrivateNetworkOnlyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getProcessorCoreAmount": { + "get": { + "description": "The total number of processor cores, summed from all processors that are attached to a piece of hardware", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getProcessorCoreAmount/", + "operationId": "SoftLayer_Hardware::getProcessorCoreAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getProcessorPhysicalCoreAmount": { + "get": { + "description": "The total number of physical processor cores, summed from all processors that are attached to a piece of hardware", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getProcessorPhysicalCoreAmount/", + "operationId": "SoftLayer_Hardware::getProcessorPhysicalCoreAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getProcessors": { + "get": { + "description": "Information regarding a piece of hardware's processors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getProcessors/", + "operationId": "SoftLayer_Hardware::getProcessors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getRack": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getRack/", + "operationId": "SoftLayer_Hardware::getRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getRaidControllers": { + "get": { + "description": "The RAID controllers contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getRaidControllers/", + "operationId": "SoftLayer_Hardware::getRaidControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getRecentEvents": { + "get": { + "description": "Recent events that impact this hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getRecentEvents/", + "operationId": "SoftLayer_Hardware::getRecentEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getRemoteManagementAccounts": { + "get": { + "description": "User credentials to issue commands and/or interact with the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getRemoteManagementAccounts/", + "operationId": "SoftLayer_Hardware::getRemoteManagementAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_User" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getRemoteManagementComponent": { + "get": { + "description": "A hardware's associated remote management component. This is normally IPMI.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getRemoteManagementComponent/", + "operationId": "SoftLayer_Hardware::getRemoteManagementComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getResourceConfigurations": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getResourceConfigurations/", + "operationId": "SoftLayer_Hardware::getResourceConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Resource_Configuration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getResourceGroupMemberReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getResourceGroupMemberReferences/", + "operationId": "SoftLayer_Hardware::getResourceGroupMemberReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group_Member" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getResourceGroupRoles": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getResourceGroupRoles/", + "operationId": "SoftLayer_Hardware::getResourceGroupRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group_Role" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getResourceGroups": { + "get": { + "description": "The resource groups in which this hardware is a member.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getResourceGroups/", + "operationId": "SoftLayer_Hardware::getResourceGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getRouters": { + "get": { + "description": "A hardware's routers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getRouters/", + "operationId": "SoftLayer_Hardware::getRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getSecurityScanRequests": { + "get": { + "description": "Information regarding a piece of hardware's vulnerability scan requests.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getSecurityScanRequests/", + "operationId": "SoftLayer_Hardware::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_Hardware/{SoftLayer_HardwareID}/getServerRoom": { + "get": { + "description": "Information regarding the server room in which the hardware is located.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getServerRoom/", + "operationId": "SoftLayer_Hardware::getServerRoom", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getServiceProvider": { + "get": { + "description": "Information regarding the piece of hardware's service provider.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getServiceProvider/", + "operationId": "SoftLayer_Hardware::getServiceProvider", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Service_Provider" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getSoftwareComponents": { + "get": { + "description": "Information regarding a piece of hardware's installed software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getSoftwareComponents/", + "operationId": "SoftLayer_Hardware::getSoftwareComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getSparePoolBillingItem": { + "get": { + "description": "Information regarding the billing item for a spare pool server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getSparePoolBillingItem/", + "operationId": "SoftLayer_Hardware::getSparePoolBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getSshKeys": { + "get": { + "description": "SSH keys to be installed on the server during provisioning or an OS reload.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getSshKeys/", + "operationId": "SoftLayer_Hardware::getSshKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getStorageGroups": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getStorageGroups/", + "operationId": "SoftLayer_Hardware::getStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getStorageNetworkComponents": { + "get": { + "description": "A piece of hardware's private storage network components. [Deprecated]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getStorageNetworkComponents/", + "operationId": "SoftLayer_Hardware::getStorageNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getTagReferences/", + "operationId": "SoftLayer_Hardware::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getTopLevelLocation": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getTopLevelLocation/", + "operationId": "SoftLayer_Hardware::getTopLevelLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getUpgradeRequest": { + "get": { + "description": "An account's associated upgrade request object, if any.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getUpgradeRequest/", + "operationId": "SoftLayer_Hardware::getUpgradeRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Upgrade_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getUpgradeableActiveComponents": { + "get": { + "description": "A piece of hardware's active upgradeable physical components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getUpgradeableActiveComponents/", + "operationId": "SoftLayer_Hardware::getUpgradeableActiveComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getUplinkHardware": { + "get": { + "description": "The network device connected to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getUplinkHardware/", + "operationId": "SoftLayer_Hardware::getUplinkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getUplinkNetworkComponents": { + "get": { + "description": "Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getUplinkNetworkComponents/", + "operationId": "SoftLayer_Hardware::getUplinkNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getUserData": { + "get": { + "description": "An array containing a single string of custom user data for a hardware order. Max size is 16 kb.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getUserData/", + "operationId": "SoftLayer_Hardware::getUserData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getVirtualChassis": { + "get": { + "description": "Information regarding the virtual chassis for a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getVirtualChassis/", + "operationId": "SoftLayer_Hardware::getVirtualChassis", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getVirtualChassisSiblings": { + "get": { + "description": "Information regarding the virtual chassis siblings for a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getVirtualChassisSiblings/", + "operationId": "SoftLayer_Hardware::getVirtualChassisSiblings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getVirtualHost": { + "get": { + "description": "A piece of hardware's virtual host record.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getVirtualHost/", + "operationId": "SoftLayer_Hardware::getVirtualHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getVirtualLicenses": { + "get": { + "description": "Information regarding a piece of hardware's virtual software licenses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getVirtualLicenses/", + "operationId": "SoftLayer_Hardware::getVirtualLicenses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_VirtualLicense" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getVirtualRack": { + "get": { + "description": "Information regarding the bandwidth allotment to which a piece of hardware belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getVirtualRack/", + "operationId": "SoftLayer_Hardware::getVirtualRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getVirtualRackId": { + "get": { + "description": "The name of the bandwidth allotment belonging to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getVirtualRackId/", + "operationId": "SoftLayer_Hardware::getVirtualRackId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getVirtualRackName": { + "get": { + "description": "The name of the bandwidth allotment belonging to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getVirtualRackName/", + "operationId": "SoftLayer_Hardware::getVirtualRackName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware/{SoftLayer_HardwareID}/getVirtualizationPlatform": { + "get": { + "description": "A piece of hardware's virtualization platform software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware/getVirtualizationPlatform/", + "operationId": "SoftLayer_Hardware::getVirtualizationPlatform", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Benchmark_Certification/{SoftLayer_Hardware_Benchmark_CertificationID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Hardware_Benchmark_Certification object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware_Benchmark_Certification service. ", + "summary": "Retrieve a SoftLayer_Hardware_Benchmark_Certification record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Benchmark_Certification/getObject/", + "operationId": "SoftLayer_Hardware_Benchmark_Certification::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Benchmark_Certification" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Benchmark_Certification/{SoftLayer_Hardware_Benchmark_CertificationID}/getResultFile": { + "get": { + "description": "Attempt to retrieve the file associated with a benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception. The \"getResultFile\" method attempts to retrieve the file associated with a benchmark certification result, if such a file exists. If no file exists for the benchmark certification, an exception is thrown. ", + "summary": "Retrieve the file for a benchmark certification result, if is exists.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Benchmark_Certification/getResultFile/", + "operationId": "SoftLayer_Hardware_Benchmark_Certification::getResultFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Benchmark_Certification/{SoftLayer_Hardware_Benchmark_CertificationID}/getAccount": { + "get": { + "description": "Information regarding a benchmark certification result's associated SoftLayer customer account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Benchmark_Certification/getAccount/", + "operationId": "SoftLayer_Hardware_Benchmark_Certification::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Benchmark_Certification/{SoftLayer_Hardware_Benchmark_CertificationID}/getHardware": { + "get": { + "description": "Information regarding the piece of hardware on which a benchmark certification test was performed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Benchmark_Certification/getHardware/", + "operationId": "SoftLayer_Hardware_Benchmark_Certification::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Blade/{SoftLayer_Hardware_BladeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Hardware_Blade record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Blade/getObject/", + "operationId": "SoftLayer_Hardware_Blade::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Blade" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Blade/{SoftLayer_Hardware_BladeID}/getHardwareChild": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Blade/getHardwareChild/", + "operationId": "SoftLayer_Hardware_Blade::getHardwareChild", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Blade/{SoftLayer_Hardware_BladeID}/getHardwareParent": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Blade/getHardwareParent/", + "operationId": "SoftLayer_Hardware_Blade::getHardwareParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Locator/getGenericComponentModelAvailability": { + "post": { + "description": null, + "summary": "An API to retrieve Generic Components Model availability at data centers", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Locator/getGenericComponentModelAvailability/", + "operationId": "SoftLayer_Hardware_Component_Locator::getGenericComponentModelAvailability", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Locator_Result" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Locator/getPackageItemsAvailability": { + "post": { + "description": null, + "summary": "Retrieve availability of specified product package's GPUs and drives", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Locator/getPackageItemsAvailability/", + "operationId": "SoftLayer_Hardware_Component_Locator::getPackageItemsAvailability", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Locator_Result" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Locator/getServerPackageAvailability": { + "get": { + "description": null, + "summary": "An API to retrieve server package availability at data centers", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Locator/getServerPackageAvailability/", + "operationId": "SoftLayer_Hardware_Component_Locator::getServerPackageAvailability", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Locator_Result" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Hardware_Component_Model object. ", + "summary": "Retrieve a SoftLayer_Hardware_Component_Model record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getObject/", + "operationId": "SoftLayer_Hardware_Component_Model::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getArchitectureType": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getArchitectureType/", + "operationId": "SoftLayer_Hardware_Component_Model::getArchitectureType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model_Architecture_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getAttributes": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getAttributes/", + "operationId": "SoftLayer_Hardware_Component_Model::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getCompatibleArrayTypes": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleArrayTypes/", + "operationId": "SoftLayer_Hardware_Component_Model::getCompatibleArrayTypes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group_Array_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getCompatibleChildComponentModels": { + "get": { + "description": "All the component models that are compatible with a hardware component model.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleChildComponentModels/", + "operationId": "SoftLayer_Hardware_Component_Model::getCompatibleChildComponentModels", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getCompatibleParentComponentModels": { + "get": { + "description": "All the component models that a hardware component model is compatible with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleParentComponentModels/", + "operationId": "SoftLayer_Hardware_Component_Model::getCompatibleParentComponentModels", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getFirmwareQuantity": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getFirmwareQuantity/", + "operationId": "SoftLayer_Hardware_Component_Model::getFirmwareQuantity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getFirmwares": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getFirmwares/", + "operationId": "SoftLayer_Hardware_Component_Model::getFirmwares", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Firmware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getHardwareComponents": { + "get": { + "description": "A hardware component model's physical components in inventory.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getHardwareComponents/", + "operationId": "SoftLayer_Hardware_Component_Model::getHardwareComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getHardwareGenericComponentModel": { + "get": { + "description": "The non-vendor specific generic component model for a hardware component model.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getHardwareGenericComponentModel/", + "operationId": "SoftLayer_Hardware_Component_Model::getHardwareGenericComponentModel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model_Generic" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getInfinibandCompatibleAttribute": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getInfinibandCompatibleAttribute/", + "operationId": "SoftLayer_Hardware_Component_Model::getInfinibandCompatibleAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getIsFlexSkuCompatible": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getIsFlexSkuCompatible/", + "operationId": "SoftLayer_Hardware_Component_Model::getIsFlexSkuCompatible", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getIsInfinibandCompatible": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getIsInfinibandCompatible/", + "operationId": "SoftLayer_Hardware_Component_Model::getIsInfinibandCompatible", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getMetricTrackingObject": { + "get": { + "description": "[DEPRECATED] - A hardware component models metric tracking object. This object records all periodic polled data available to this hardware componet model.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getMetricTrackingObject/", + "operationId": "SoftLayer_Hardware_Component_Model::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getQualifiedFirmwares": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getQualifiedFirmwares/", + "operationId": "SoftLayer_Hardware_Component_Model::getQualifiedFirmwares", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Firmware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getRebootTime": { + "get": { + "description": "A motherboard's average reboot time.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getRebootTime/", + "operationId": "SoftLayer_Hardware_Component_Model::getRebootTime", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Motherboard_Reboot_Time" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getType": { + "get": { + "description": "A hardware component model's type.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getType/", + "operationId": "SoftLayer_Hardware_Component_Model::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getValidAttributeTypes": { + "get": { + "description": "The types of attributes that are allowed for a given hardware component model.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getValidAttributeTypes/", + "operationId": "SoftLayer_Hardware_Component_Model::getValidAttributeTypes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model_Attribute_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getVmwareQualifiedFirmwares": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Model/getVmwareQualifiedFirmwares/", + "operationId": "SoftLayer_Hardware_Component_Model::getVmwareQualifiedFirmwares", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Firmware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Partition_OperatingSystem/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getAllObjects/", + "operationId": "SoftLayer_Hardware_Component_Partition_OperatingSystem::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Partition_OperatingSystem" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Partition_OperatingSystem/getByDescription": { + "post": { + "description": "The '''getByDescription''' method retrieves all possible partition templates based on the description (required parameter) entered when calling the method. The description is typically the operating system's name. Current recognized values include 'linux', 'windows', 'freebsd', and 'Debian'. ", + "summary": "Retrieves a list of all partition templates that match a certain description.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getByDescription/", + "operationId": "SoftLayer_Hardware_Component_Partition_OperatingSystem::getByDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Partition_OperatingSystem" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Partition_OperatingSystem/{SoftLayer_Hardware_Component_Partition_OperatingSystemID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Hardware_Component_Partition_OperatingSystem object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware_Component_Partition_OperatingSystem service.s ", + "summary": "Retrieve a SoftLayer_Hardware_Component_Partition_OperatingSystem record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getObject/", + "operationId": "SoftLayer_Hardware_Component_Partition_OperatingSystem::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Partition_OperatingSystem" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Partition_OperatingSystem/{SoftLayer_Hardware_Component_Partition_OperatingSystemID}/getPartitionTemplates": { + "get": { + "description": "Information regarding an operating system's [[SoftLayer_Hardware_Component_Partition_Template|Partition Templates]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getPartitionTemplates/", + "operationId": "SoftLayer_Hardware_Component_Partition_OperatingSystem::getPartitionTemplates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Partition_Template" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Partition_Template/{SoftLayer_Hardware_Component_Partition_TemplateID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Hardware_Component_Partition_Template object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware_Component_Partition_Template service. You can only retrieve the partition templates that your account created or the templates predefined by SoftLayer. ", + "summary": "Retrieve a SoftLayer_Hardware_Component_Partition_Template record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Partition_Template/getObject/", + "operationId": "SoftLayer_Hardware_Component_Partition_Template::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Partition_Template" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Partition_Template/{SoftLayer_Hardware_Component_Partition_TemplateID}/getAccount": { + "get": { + "description": "A partition template's associated [[SoftLayer_Account|Account]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Partition_Template/getAccount/", + "operationId": "SoftLayer_Hardware_Component_Partition_Template::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Partition_Template/{SoftLayer_Hardware_Component_Partition_TemplateID}/getData": { + "get": { + "description": "An individual partition for a partition template. This is identical to 'partitionTemplatePartition' except this will sort unix partitions.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Partition_Template/getData/", + "operationId": "SoftLayer_Hardware_Component_Partition_Template::getData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Partition_Template_Partition" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Partition_Template/{SoftLayer_Hardware_Component_Partition_TemplateID}/getExpireDate": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Partition_Template/getExpireDate/", + "operationId": "SoftLayer_Hardware_Component_Partition_Template::getExpireDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Partition_Template/{SoftLayer_Hardware_Component_Partition_TemplateID}/getPartitionOperatingSystem": { + "get": { + "description": "A partition template's associated [[SoftLayer_Hardware_Component_Partition_OperatingSystem|Operating System]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionOperatingSystem/", + "operationId": "SoftLayer_Hardware_Component_Partition_Template::getPartitionOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Partition_OperatingSystem" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Component_Partition_Template/{SoftLayer_Hardware_Component_Partition_TemplateID}/getPartitionTemplatePartition": { + "get": { + "description": "An individual partition for a partition template.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionTemplatePartition/", + "operationId": "SoftLayer_Hardware_Component_Partition_Template::getPartitionTemplatePartition", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Partition_Template_Partition" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Hardware_Router record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getObject/", + "operationId": "SoftLayer_Hardware_Router::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Router" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/allowAccessToNetworkStorage": { + "post": { + "description": "This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control. ", + "summary": "Allow access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorage/", + "operationId": "SoftLayer_Hardware_Router::allowAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/allowAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Allow access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorageList/", + "operationId": "SoftLayer_Hardware_Router::allowAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/captureImage": { + "post": { + "description": "Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image. ", + "summary": "Captures an Image of the hard disk on the physical machine.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/captureImage/", + "operationId": "SoftLayer_Hardware_Router::captureImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/createObject": { + "post": { + "description": "\n \ncreateObject() enables the creation of servers on an account. This \nmethod is a simplified alternative to interacting with the ordering system directly. \n\n\nIn order to create a server, a template object must be sent in with a few required \nvalues. \n\n\nWhen this method returns an order will have been placed for a server of the specified configuration. \n\n\nTo determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]], \nchecking the 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 \n
    Hostname for the server.
      \n
    • Required
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
  • domain \n
    Domain for the server.
      \n
    • Required
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
  • processorCoreAmount \n
    The number of logical CPU cores to allocate.
      \n
    • Required
      • \n
    • Type - int
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n
    \n
    • \n
  • memoryCapacity \n
    The amount of memory to allocate in gigabytes.
      \n
    • Required
      • \n
    • Type - int
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n
    \n
    • \n
  • hourlyBillingFlag \n
    Specifies 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
    • \n
  • operatingSystemReferenceCode \n
    An 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
    • \n
  • datacenter.name \n
    Specifies which datacenter the server is to be provisioned in.
      \n
    • Required
      • \n
    • Type - string
      • \n
    • The datacenter property is a [[SoftLayer_Location (type)|location]] structure with the name field set.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"datacenter\": { \n \"name\": \"dal05\" \n } \n} \n
    \n
    • \n
  • networkComponents.maxSpeed \n
    Specifies 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 networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The maxSpeed property 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 { \n \"networkComponents\": [ \n { \n \"maxSpeed\": 1000 \n } \n ] \n} \n
    \n
    • \n
  • networkComponents.redundancyEnabledFlag \n
    Specifies whether or not the server's network components should be in redundancy groups.
      \n
    • Optional
      • \n
    • Type - bool
      • \n
    • Default - false
      • \n
    • Description - The networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the redundancyEnabledFlag property is true the server's network components will be in redundancy groups.
      • \n
    \n { \n \"networkComponents\": [ \n { \n \"redundancyEnabledFlag\": false \n } \n ] \n} \n
    \n
    • \n
  • privateNetworkOnlyFlag \n
    Specifies 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
    • \n
  • primaryNetworkComponent.networkVlan.id \n
    Specifies the network vlan which is to be used for the frontend interface of the server.
      \n
    • Optional
      • \n
    • Type - int
      • \n
    • Description - The primaryNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the frontend network vlan of the server.
      • \n
    \n { \n \"primaryNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 1 \n } \n } \n} \n
    \n
    • \n
  • primaryBackendNetworkComponent.networkVlan.id \n
    Specifies the network vlan which is to be used for the backend interface of the server.
      \n
    • Optional
      • \n
    • Type - int
      • \n
    • Description - The primaryBackendNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the backend network vlan of the server.
      • \n
    \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 fixedConfigurationPreset property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The keyName property must be set to specify preset to use.
      • \n
    • If a fixed configuration preset is used processorCoreAmount, memoryCapacity and hardDrives properties must not be set.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"fixedConfigurationPreset\": { \n \"keyName\": \"SOME_KEY_NAME\" \n } \n} \n
    \n
    • \n
  • userData.value \n
    Arbitrary data to be made available to the server.
      \n
    • Optional
      • \n
    • Type - string
      • \n
    • Description - The userData property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the value property 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 { \n \"userData\": [ \n { \n \"value\": \"someValue\" \n } \n ] \n} \n
    \n
    • \n
  • hardDrives \n
    Hard 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 hardDrives property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures. \n
    • Each hard drive must specify the capacity property.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"hardDrives\": [ \n { \n \"capacity\": 500 \n } \n ] \n} \n
    \n
    • \n
  • sshKeys \n
    SSH 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 sshKeys property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the id property 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 { \n \"sshKeys\": [ \n { \n \"id\": 123 \n } \n ] \n} \n
    \n
    • \n
  • postInstallScriptUri \n
    Specifies the uri location of the script to be downloaded and run after installation is complete.
      \n
    • Optional
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
\n\n\n

REST Example

\ncurl -X POST -d '{ \n \"parameters\":[ \n { \n \"hostname\": \"host1\", \n \"domain\": \"example.com\", \n \"processorCoreAmount\": 2, \n \"memoryCapacity\": 2, \n \"hourlyBillingFlag\": true, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\" \n } \n ] \n}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json \n \nHTTP/1.1 201 Created \nLocation: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject \n\n\n{ \n \"accountId\": 232298, \n \"bareMetalInstanceFlag\": null, \n \"domain\": \"example.com\", \n \"hardwareStatusId\": null, \n \"hostname\": \"host1\", \n \"id\": null, \n \"serviceProviderId\": null, \n \"serviceProviderResourceId\": null, \n \"globalIdentifier\": \"f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5\", \n \"hourlyBillingFlag\": true, \n \"memoryCapacity\": 2, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\", \n \"processorCoreAmount\": 2 \n} \n ", + "summary": "Create a new server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/createObject/", + "operationId": "SoftLayer_Hardware_Router::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/deleteObject": { + "get": { + "description": "\nThis method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns. ", + "summary": "Delete a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/deleteObject/", + "operationId": "SoftLayer_Hardware_Router::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/deleteSoftwareComponentPasswords": { + "post": { + "description": "Delete software component passwords. ", + "summary": "Delete software component passwords.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/deleteSoftwareComponentPasswords/", + "operationId": "SoftLayer_Hardware_Router::deleteSoftwareComponentPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/deleteTag": { + "post": { + "description": "Delete an existing tag. If there are any references on the tag, an exception will be thrown. ", + "summary": "Delete a tag", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/deleteTag/", + "operationId": "SoftLayer_Hardware_Router::deleteTag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/editSoftwareComponentPasswords": { + "post": { + "description": "Edit the properties of a software component password such as the username, password, and notes. ", + "summary": "Edit the properties of software component passwords.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/editSoftwareComponentPasswords/", + "operationId": "SoftLayer_Hardware_Router::editSoftwareComponentPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/executeRemoteScript": { + "post": { + "description": "Download and run remote script from uri on the hardware.", + "summary": "Download and run remote script from uri on the hardware. Requires https for script to be executed after download. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/executeRemoteScript/", + "operationId": "SoftLayer_Hardware_Router::executeRemoteScript", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/findByIpAddress": { + "post": { + "description": "The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned. ", + "summary": "Find hardware by its primary public or private IP (ipv4) address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/findByIpAddress/", + "operationId": "SoftLayer_Hardware_Router::findByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/generateOrderTemplate": { + "post": { + "description": "\nObtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]]. \n\n\nThis is primarily useful when there is a necessity to confirm the price which will be charged for an order. \n\n\nSee [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter. ", + "summary": "Obtain an order container for a given template object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/generateOrderTemplate/", + "operationId": "SoftLayer_Hardware_Router::generateOrderTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAttachedNetworkStorages": { + "post": { + "description": "This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAttachedNetworkStorages/", + "operationId": "SoftLayer_Hardware_Router::getAttachedNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAvailableBillingTermChangePrices": { + "get": { + "description": "Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers. ", + "summary": "Retrieves a list of available term prices available to this of hardware. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAvailableBillingTermChangePrices/", + "operationId": "SoftLayer_Hardware_Router::getAvailableBillingTermChangePrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAvailableNetworkStorages": { + "post": { + "description": "This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAvailableNetworkStorages/", + "operationId": "SoftLayer_Hardware_Router::getAvailableNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBackendIncomingBandwidth": { + "post": { + "description": "The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes. ", + "summary": "Retrieve the amount of incoming private network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBackendIncomingBandwidth/", + "operationId": "SoftLayer_Hardware_Router::getBackendIncomingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBackendOutgoingBandwidth": { + "post": { + "description": "The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes. ", + "summary": "Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBackendOutgoingBandwidth/", + "operationId": "SoftLayer_Hardware_Router::getBackendOutgoingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getComponentDetailsXML": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getComponentDetailsXML/", + "operationId": "SoftLayer_Hardware_Router::getComponentDetailsXML", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/getCreateObjectOptions": { + "get": { + "description": "\nThere are many options that may be provided while ordering a server, this method can be used to determine what these options are. \n\n\nDetailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]]. ", + "summary": "Determine options available when creating a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getCreateObjectOptions/", + "operationId": "SoftLayer_Hardware_Router::getCreateObjectOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Configuration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getCurrentBillingDetail": { + "get": { + "description": "Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage. ", + "summary": "<< EOT", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getCurrentBillingDetail/", + "operationId": "SoftLayer_Hardware_Router::getCurrentBillingDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getCurrentBillingTotal": { + "get": { + "description": "Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware. ", + "summary": "Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getCurrentBillingTotal/", + "operationId": "SoftLayer_Hardware_Router::getCurrentBillingTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDailyAverage": { + "post": { + "description": "The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day. ", + "summary": "calculate the average daily network traffic used by a server in gigabytes.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDailyAverage/", + "operationId": "SoftLayer_Hardware_Router::getDailyAverage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getFrontendIncomingBandwidth": { + "post": { + "description": "The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB). ", + "summary": "Retrieve the amount of incoming public network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getFrontendIncomingBandwidth/", + "operationId": "SoftLayer_Hardware_Router::getFrontendIncomingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getFrontendOutgoingBandwidth": { + "post": { + "description": "The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB). ", + "summary": "Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getFrontendOutgoingBandwidth/", + "operationId": "SoftLayer_Hardware_Router::getFrontendOutgoingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getHourlyBandwidth": { + "post": { + "description": "The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of \n\n'02/01/2008 0:00' \n\nresults in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time). \n\nFor data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware. ", + "summary": "Retrieves bandwidth hourly over a 24-hour period for the specified hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getHourlyBandwidth/", + "operationId": "SoftLayer_Hardware_Router::getHourlyBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getPrivateBandwidthData": { + "post": { + "description": "Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. ", + "summary": "Retrieve a graph of a server's private network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getPrivateBandwidthData/", + "operationId": "SoftLayer_Hardware_Router::getPrivateBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getPublicBandwidthData": { + "post": { + "description": "Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. ", + "summary": "Retrieve a graph of a server's public network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getPublicBandwidthData/", + "operationId": "SoftLayer_Hardware_Router::getPublicBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getSensorData": { + "get": { + "description": "The '''getSensorData''' method retrieves a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures various information, including system temperatures, voltages and other local server settings. Sensor data is cached for 30 second; calls made to this method for the same server within 30 seconds of each other will result in the same data being returned. To ensure that the data retrieved retrieves snapshot of varied data, make calls greater than 30 seconds apart. ", + "summary": "Retrieve a server's hardware state via its internal sensors", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getSensorData/", + "operationId": "SoftLayer_Hardware_Router::getSensorData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_SensorReading" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getSensorDataWithGraphs": { + "get": { + "description": "The '''getSensorDataWithGraphs''' method retrieves the raw data returned from the server's remote management card. Along with raw data, graphs for the CPU and system temperatures and fan speeds are also returned. For more details on what information is returned, refer to the ''getSensorData'' method. ", + "summary": "Retrieve server's temperature and fan speed graphs as well the sensor raw data.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getSensorDataWithGraphs/", + "operationId": "SoftLayer_Hardware_Router::getSensorDataWithGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getServerFanSpeedGraphs": { + "get": { + "description": "The '''getServerFanSpeedGraphs''' method retrieves the server's fan speeds and displays the speeds using tachometer graphs. data used to construct these graphs is retrieved from the server's remote management card. Each graph returned will have an associated title. ", + "summary": "Retrieve a server's fan speed graphs.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getServerFanSpeedGraphs/", + "operationId": "SoftLayer_Hardware_Router::getServerFanSpeedGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getServerPowerState": { + "get": { + "description": "The '''getPowerState''' method retrieves the power state for the selected server. The server's power status is retrieved from its remote management card. This method returns \"on\", for a server that has been powered on, or \"off\" for servers powered off. ", + "summary": "Retrieves a server's power state.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getServerPowerState/", + "operationId": "SoftLayer_Hardware_Router::getServerPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getServerTemperatureGraphs": { + "get": { + "description": "The '''getServerTemperatureGraphs''' retrieves the server's temperatures and displays the various temperatures using thermometer graphs. Temperatures retrieved are CPU temperature(s) and system temperatures. Data used to construct the graphs is retrieved from the server's remote management card. All graphs returned will have an associated title. ", + "summary": "Retrieve server's temperature graphs", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getServerTemperatureGraphs/", + "operationId": "SoftLayer_Hardware_Router::getServerTemperatureGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getTransactionHistory": { + "get": { + "description": "\nThis method will query transaction history for a piece of hardware. ", + "summary": "Get transaction history for a piece of hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getTransactionHistory/", + "operationId": "SoftLayer_Hardware_Router::getTransactionHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getUpgradeItemPrices": { + "get": { + "description": "Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs. ", + "summary": "Retrieve a list of upgradeable items available to a piece of hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getUpgradeItemPrices/", + "operationId": "SoftLayer_Hardware_Router::getUpgradeItemPrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/importVirtualHost": { + "get": { + "description": "The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.", + "summary": "attempt to import the host record for the virtualization platform running on a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/importVirtualHost/", + "operationId": "SoftLayer_Hardware_Router::importVirtualHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/isPingable": { + "get": { + "description": "The '''isPingable''' method issues a ping command to the selected server and returns the result of the ping command. This boolean return value displays ''true'' upon successful ping or ''false'' for a failed ping. ", + "summary": "Verifies whether or not a server is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/isPingable/", + "operationId": "SoftLayer_Hardware_Router::isPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/ping": { + "get": { + "description": "Issues a ping command to the server and returns the ping response. ", + "summary": "Issues ping command.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/ping/", + "operationId": "SoftLayer_Hardware_Router::ping", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/powerCycle": { + "get": { + "description": "The '''powerCycle''' method completes a power off and power on of the server successively in one command. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. '''This method should only be used when all other options have been exhausted'''. Additional remote management commands may not be executed if this command was successfully issued within the last 20 minutes to avoid server failure. Remote management commands include: \n\nrebootSoft rebootHard powerOn powerOff powerCycle \n\n", + "summary": "Issues power cycle to server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/powerCycle/", + "operationId": "SoftLayer_Hardware_Router::powerCycle", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/powerOff": { + "get": { + "description": "This method will power off the server via the server's remote management card. ", + "summary": "Power off server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/powerOff/", + "operationId": "SoftLayer_Hardware_Router::powerOff", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/powerOn": { + "get": { + "description": "The '''powerOn''' method powers on a server via its remote management card. This boolean return value returns ''true'' upon successful execution and ''false'' if unsuccessful. Other remote management commands may not be issued in this command was successfully completed within the last 20 minutes to avoid server failure. Remote management commands include: \n\nrebootSoft rebootHard powerOn powerOff powerCycle \n\n", + "summary": "Power on server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/powerOn/", + "operationId": "SoftLayer_Hardware_Router::powerOn", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/rebootDefault": { + "get": { + "description": "The '''rebootDefault''' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card. if the reset attempt is unsuccessful, a power cycle command will be issued via the power strip. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. If the reset was successful within the last 20 minutes, another remote management command cannot be completed to avoid server failure. Remote management commands include: \n\nrebootSoft rebootHard powerOn powerOff powerCycle \n\n", + "summary": "Reboot the server via the default method.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/rebootDefault/", + "operationId": "SoftLayer_Hardware_Router::rebootDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/rebootHard": { + "get": { + "description": "The '''rebootHard''' method reboots the server by issuing a cycle command to the server's remote management card. A hard reboot is equivalent to pressing the ''Reset'' button on a server - it is issued immediately and will not allow processes to shut down prior to the reboot. Completing a hard reboot may initiate system disk checks upon server reboot, causing the boot up to take longer than normally expected. \n\nRemote management commands are unable to be executed if a reboot has been issued successfully within the last 20 minutes to avoid server failure. Remote management commands include: \n\nrebootSoft rebootHard powerOn powerOff powerCycle \n\n", + "summary": "Reboot the server via \"hard\" reboot.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/rebootHard/", + "operationId": "SoftLayer_Hardware_Router::rebootHard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/rebootSoft": { + "get": { + "description": "The '''rebootSoft''' method reboots the server by issuing a reset command to the server's remote management card via soft reboot. When executing a soft reboot, servers allow all processes to shut down completely before rebooting. Remote management commands are unable to be issued within 20 minutes of issuing a successful soft reboot in order to avoid server failure. Remote management commands include: \n\nrebootSoft rebootHard powerOn powerOff powerCycle \n\n", + "summary": "Execute a soft reboot to the server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/rebootSoft/", + "operationId": "SoftLayer_Hardware_Router::rebootSoft", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/refreshDeviceStatus": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/refreshDeviceStatus/", + "operationId": "SoftLayer_Hardware_Router::refreshDeviceStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/removeAccessToNetworkStorage": { + "post": { + "description": "This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control. ", + "summary": "Remove access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorage/", + "operationId": "SoftLayer_Hardware_Router::removeAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/removeAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Remove access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorageList/", + "operationId": "SoftLayer_Hardware_Router::removeAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/removeTags": { + "post": { + "description": null, + "summary": "Remove a tag reference", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/removeTags/", + "operationId": "SoftLayer_Hardware_Router::removeTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/setTags": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/setTags/", + "operationId": "SoftLayer_Hardware_Router::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/updateIpmiPassword": { + "post": { + "description": "This method will update the root IPMI password on this SoftLayer_Hardware. ", + "summary": "Update the root IPMI user password ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/updateIpmiPassword/", + "operationId": "SoftLayer_Hardware_Router::updateIpmiPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBoundSubnets": { + "get": { + "description": "Associated subnets for a router object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBoundSubnets/", + "operationId": "SoftLayer_Hardware_Router::getBoundSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getLocalDiskStorageCapabilityFlag": { + "get": { + "description": "A flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getLocalDiskStorageCapabilityFlag/", + "operationId": "SoftLayer_Hardware_Router::getLocalDiskStorageCapabilityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getSanStorageCapabilityFlag": { + "get": { + "description": "A flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getSanStorageCapabilityFlag/", + "operationId": "SoftLayer_Hardware_Router::getSanStorageCapabilityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAccount": { + "get": { + "description": "The account associated with a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAccount/", + "operationId": "SoftLayer_Hardware_Router::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getActiveComponents": { + "get": { + "description": "A piece of hardware's active physical components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getActiveComponents/", + "operationId": "SoftLayer_Hardware_Router::getActiveComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getActiveNetworkMonitorIncident": { + "get": { + "description": "A piece of hardware's active network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getActiveNetworkMonitorIncident/", + "operationId": "SoftLayer_Hardware_Router::getActiveNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAllPowerComponents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAllPowerComponents/", + "operationId": "SoftLayer_Hardware_Router::getAllPowerComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Power_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAllowedHost": { + "get": { + "description": "The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAllowedHost/", + "operationId": "SoftLayer_Hardware_Router::getAllowedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAllowedNetworkStorage": { + "get": { + "description": "The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorage/", + "operationId": "SoftLayer_Hardware_Router::getAllowedNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAllowedNetworkStorageReplicas": { + "get": { + "description": "The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorageReplicas/", + "operationId": "SoftLayer_Hardware_Router::getAllowedNetworkStorageReplicas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAntivirusSpywareSoftwareComponent": { + "get": { + "description": "Information regarding an antivirus/spyware software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAntivirusSpywareSoftwareComponent/", + "operationId": "SoftLayer_Hardware_Router::getAntivirusSpywareSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAttributes": { + "get": { + "description": "Information regarding a piece of hardware's specific attributes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAttributes/", + "operationId": "SoftLayer_Hardware_Router::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getAverageDailyPublicBandwidthUsage": { + "get": { + "description": "The average daily public bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getAverageDailyPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Router::getAverageDailyPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBackendNetworkComponents": { + "get": { + "description": "A piece of hardware's back-end or private network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBackendNetworkComponents/", + "operationId": "SoftLayer_Hardware_Router::getBackendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBackendRouters": { + "get": { + "description": "A hardware's backend or private router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBackendRouters/", + "operationId": "SoftLayer_Hardware_Router::getBackendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBandwidthAllocation": { + "get": { + "description": "A hardware's allotted bandwidth (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBandwidthAllocation/", + "operationId": "SoftLayer_Hardware_Router::getBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBandwidthAllotmentDetail": { + "get": { + "description": "A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBandwidthAllotmentDetail/", + "operationId": "SoftLayer_Hardware_Router::getBandwidthAllotmentDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBenchmarkCertifications": { + "get": { + "description": "Information regarding a piece of hardware's benchmark certifications.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBenchmarkCertifications/", + "operationId": "SoftLayer_Hardware_Router::getBenchmarkCertifications", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Benchmark_Certification" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBillingItem": { + "get": { + "description": "Information regarding the billing item for a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBillingItem/", + "operationId": "SoftLayer_Hardware_Router::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBillingItemFlag": { + "get": { + "description": "A flag indicating that a billing item exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBillingItemFlag/", + "operationId": "SoftLayer_Hardware_Router::getBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBlockCancelBecauseDisconnectedFlag": { + "get": { + "description": "Determines whether the hardware is ineligible for cancellation because it is disconnected.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBlockCancelBecauseDisconnectedFlag/", + "operationId": "SoftLayer_Hardware_Router::getBlockCancelBecauseDisconnectedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBusinessContinuanceInsuranceFlag": { + "get": { + "description": "Status indicating whether or not a piece of hardware has business continuance insurance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getBusinessContinuanceInsuranceFlag/", + "operationId": "SoftLayer_Hardware_Router::getBusinessContinuanceInsuranceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getChildrenHardware": { + "get": { + "description": "Child hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getChildrenHardware/", + "operationId": "SoftLayer_Hardware_Router::getChildrenHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getComponents": { + "get": { + "description": "A piece of hardware's components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getComponents/", + "operationId": "SoftLayer_Hardware_Router::getComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getContinuousDataProtectionSoftwareComponent": { + "get": { + "description": "A continuous data protection/server backup software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getContinuousDataProtectionSoftwareComponent/", + "operationId": "SoftLayer_Hardware_Router::getContinuousDataProtectionSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getCurrentBillableBandwidthUsage": { + "get": { + "description": "The current billable public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getCurrentBillableBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Router::getCurrentBillableBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDatacenter": { + "get": { + "description": "Information regarding the datacenter in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDatacenter/", + "operationId": "SoftLayer_Hardware_Router::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDatacenterName": { + "get": { + "description": "The name of the datacenter in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDatacenterName/", + "operationId": "SoftLayer_Hardware_Router::getDatacenterName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDaysInSparePool": { + "get": { + "description": "Number of day(s) a server have been in spare pool.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDaysInSparePool/", + "operationId": "SoftLayer_Hardware_Router::getDaysInSparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownlinkHardware": { + "get": { + "description": "All hardware that has uplink network connections to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDownlinkHardware/", + "operationId": "SoftLayer_Hardware_Router::getDownlinkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownlinkNetworkHardware": { + "get": { + "description": "All hardware that has uplink network connections to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDownlinkNetworkHardware/", + "operationId": "SoftLayer_Hardware_Router::getDownlinkNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownlinkServers": { + "get": { + "description": "Information regarding all servers attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDownlinkServers/", + "operationId": "SoftLayer_Hardware_Router::getDownlinkServers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownlinkVirtualGuests": { + "get": { + "description": "Information regarding all virtual guests attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDownlinkVirtualGuests/", + "operationId": "SoftLayer_Hardware_Router::getDownlinkVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownstreamHardwareBindings": { + "get": { + "description": "All hardware downstream from a network device.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDownstreamHardwareBindings/", + "operationId": "SoftLayer_Hardware_Router::getDownstreamHardwareBindings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Uplink_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownstreamNetworkHardware": { + "get": { + "description": "All network hardware downstream from the selected piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardware/", + "operationId": "SoftLayer_Hardware_Router::getDownstreamNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownstreamNetworkHardwareWithIncidents": { + "get": { + "description": "All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardwareWithIncidents/", + "operationId": "SoftLayer_Hardware_Router::getDownstreamNetworkHardwareWithIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownstreamServers": { + "get": { + "description": "Information regarding all servers attached downstream to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDownstreamServers/", + "operationId": "SoftLayer_Hardware_Router::getDownstreamServers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownstreamVirtualGuests": { + "get": { + "description": "Information regarding all virtual guests attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDownstreamVirtualGuests/", + "operationId": "SoftLayer_Hardware_Router::getDownstreamVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDriveControllers": { + "get": { + "description": "The drive controllers contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getDriveControllers/", + "operationId": "SoftLayer_Hardware_Router::getDriveControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getEvaultNetworkStorage": { + "get": { + "description": "Information regarding a piece of hardware's associated EVault network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getEvaultNetworkStorage/", + "operationId": "SoftLayer_Hardware_Router::getEvaultNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getFirewallServiceComponent": { + "get": { + "description": "Information regarding a piece of hardware's firewall services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getFirewallServiceComponent/", + "operationId": "SoftLayer_Hardware_Router::getFirewallServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getFixedConfigurationPreset": { + "get": { + "description": "Defines the fixed components in a fixed configuration bare metal server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getFixedConfigurationPreset/", + "operationId": "SoftLayer_Hardware_Router::getFixedConfigurationPreset", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getFrontendNetworkComponents": { + "get": { + "description": "A piece of hardware's front-end or public network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getFrontendNetworkComponents/", + "operationId": "SoftLayer_Hardware_Router::getFrontendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getFrontendRouters": { + "get": { + "description": "A hardware's frontend or public router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getFrontendRouters/", + "operationId": "SoftLayer_Hardware_Router::getFrontendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getFutureBillingItem": { + "get": { + "description": "Information regarding the future billing item for a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getFutureBillingItem/", + "operationId": "SoftLayer_Hardware_Router::getFutureBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getGlobalIdentifier": { + "get": { + "description": "A hardware's universally unique identifier.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getGlobalIdentifier/", + "operationId": "SoftLayer_Hardware_Router::getGlobalIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getHardDrives": { + "get": { + "description": "The hard drives contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getHardDrives/", + "operationId": "SoftLayer_Hardware_Router::getHardDrives", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getHardwareChassis": { + "get": { + "description": "The chassis that a piece of hardware is housed in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getHardwareChassis/", + "operationId": "SoftLayer_Hardware_Router::getHardwareChassis", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Chassis" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getHardwareFunction": { + "get": { + "description": "A hardware's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getHardwareFunction/", + "operationId": "SoftLayer_Hardware_Router::getHardwareFunction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Function" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getHardwareFunctionDescription": { + "get": { + "description": "A hardware's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getHardwareFunctionDescription/", + "operationId": "SoftLayer_Hardware_Router::getHardwareFunctionDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getHardwareState": { + "get": { + "description": "A hardware's power/transaction state.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getHardwareState/", + "operationId": "SoftLayer_Hardware_Router::getHardwareState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getHardwareStatus": { + "get": { + "description": "A hardware's status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getHardwareStatus/", + "operationId": "SoftLayer_Hardware_Router::getHardwareStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getHasTrustedPlatformModuleBillingItemFlag": { + "get": { + "description": "Determine in hardware object has TPM enabled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getHasTrustedPlatformModuleBillingItemFlag/", + "operationId": "SoftLayer_Hardware_Router::getHasTrustedPlatformModuleBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getHostIpsSoftwareComponent": { + "get": { + "description": "Information regarding a host IPS software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getHostIpsSoftwareComponent/", + "operationId": "SoftLayer_Hardware_Router::getHostIpsSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getHourlyBillingFlag": { + "get": { + "description": "A server's hourly billing status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getHourlyBillingFlag/", + "operationId": "SoftLayer_Hardware_Router::getHourlyBillingFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getInboundBandwidthUsage": { + "get": { + "description": "The sum of all the inbound network traffic data for the last 30 days.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getInboundBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Router::getInboundBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getInboundPublicBandwidthUsage": { + "get": { + "description": "The total public inbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getInboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Router::getInboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getIsBillingTermChangeAvailableFlag": { + "get": { + "description": "Whether or not this hardware object is eligible to change to term billing.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getIsBillingTermChangeAvailableFlag/", + "operationId": "SoftLayer_Hardware_Router::getIsBillingTermChangeAvailableFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getIsCloudReadyNodeCertified": { + "get": { + "description": "Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getIsCloudReadyNodeCertified/", + "operationId": "SoftLayer_Hardware_Router::getIsCloudReadyNodeCertified", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getLastTransaction": { + "get": { + "description": "Information regarding the last transaction a server performed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getLastTransaction/", + "operationId": "SoftLayer_Hardware_Router::getLastTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getLatestNetworkMonitorIncident": { + "get": { + "description": "A piece of hardware's latest network monitoring incident.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getLatestNetworkMonitorIncident/", + "operationId": "SoftLayer_Hardware_Router::getLatestNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getLocation": { + "get": { + "description": "Where a piece of hardware is located within SoftLayer's location hierarchy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getLocation/", + "operationId": "SoftLayer_Hardware_Router::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getLocationPathString": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getLocationPathString/", + "operationId": "SoftLayer_Hardware_Router::getLocationPathString", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getLockboxNetworkStorage": { + "get": { + "description": "Information regarding a lockbox account associated with a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getLockboxNetworkStorage/", + "operationId": "SoftLayer_Hardware_Router::getLockboxNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getManagedResourceFlag": { + "get": { + "description": "A flag indicating that the hardware is a managed resource.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getManagedResourceFlag/", + "operationId": "SoftLayer_Hardware_Router::getManagedResourceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getMemory": { + "get": { + "description": "Information regarding a piece of hardware's memory.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getMemory/", + "operationId": "SoftLayer_Hardware_Router::getMemory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getMemoryCapacity": { + "get": { + "description": "The amount of memory a piece of hardware has, measured in gigabytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getMemoryCapacity/", + "operationId": "SoftLayer_Hardware_Router::getMemoryCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getMetricTrackingObject": { + "get": { + "description": "A piece of hardware's metric tracking object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getMetricTrackingObject/", + "operationId": "SoftLayer_Hardware_Router::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getModules": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getModules/", + "operationId": "SoftLayer_Hardware_Router::getModules", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getMonitoringRobot": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getMonitoringRobot/", + "operationId": "SoftLayer_Hardware_Router::getMonitoringRobot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Monitoring_Robot" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getMonitoringServiceComponent": { + "get": { + "description": "Information regarding a piece of hardware's network monitoring services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceComponent/", + "operationId": "SoftLayer_Hardware_Router::getMonitoringServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getMonitoringServiceEligibilityFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceEligibilityFlag/", + "operationId": "SoftLayer_Hardware_Router::getMonitoringServiceEligibilityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getMotherboard": { + "get": { + "description": "Information regarding a piece of hardware's motherboard.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getMotherboard/", + "operationId": "SoftLayer_Hardware_Router::getMotherboard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkCards": { + "get": { + "description": "Information regarding a piece of hardware's network cards.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkCards/", + "operationId": "SoftLayer_Hardware_Router::getNetworkCards", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkComponents": { + "get": { + "description": "Returns a hardware's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkComponents/", + "operationId": "SoftLayer_Hardware_Router::getNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkGatewayMember": { + "get": { + "description": "The gateway member if this device is part of a network gateway.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMember/", + "operationId": "SoftLayer_Hardware_Router::getNetworkGatewayMember", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkGatewayMemberFlag": { + "get": { + "description": "Whether or not this device is part of a network gateway.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMemberFlag/", + "operationId": "SoftLayer_Hardware_Router::getNetworkGatewayMemberFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkManagementIpAddress": { + "get": { + "description": "A piece of hardware's network management IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkManagementIpAddress/", + "operationId": "SoftLayer_Hardware_Router::getNetworkManagementIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkMonitorAttachedDownHardware": { + "get": { + "description": "All servers with failed monitoring that are attached downstream to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownHardware/", + "operationId": "SoftLayer_Hardware_Router::getNetworkMonitorAttachedDownHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkMonitorAttachedDownVirtualGuests": { + "get": { + "description": "Virtual guests that are attached downstream to a hardware that have failed monitoring", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownVirtualGuests/", + "operationId": "SoftLayer_Hardware_Router::getNetworkMonitorAttachedDownVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkMonitorIncidents": { + "get": { + "description": "The status of all of a piece of hardware's network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorIncidents/", + "operationId": "SoftLayer_Hardware_Router::getNetworkMonitorIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkMonitors": { + "get": { + "description": "Information regarding a piece of hardware's network monitors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkMonitors/", + "operationId": "SoftLayer_Hardware_Router::getNetworkMonitors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkStatus": { + "get": { + "description": "The value of a hardware's network status attribute. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkStatus/", + "operationId": "SoftLayer_Hardware_Router::getNetworkStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkStatusAttribute": { + "get": { + "description": "The hardware's related network status attribute. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkStatusAttribute/", + "operationId": "SoftLayer_Hardware_Router::getNetworkStatusAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkStorage": { + "get": { + "description": "Information regarding a piece of hardware's associated network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkStorage/", + "operationId": "SoftLayer_Hardware_Router::getNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkVlans": { + "get": { + "description": "The network virtual LANs (VLANs) associated with a piece of hardware's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNetworkVlans/", + "operationId": "SoftLayer_Hardware_Router::getNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNextBillingCycleBandwidthAllocation": { + "get": { + "description": "A hardware's allotted bandwidth for the next billing cycle (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNextBillingCycleBandwidthAllocation/", + "operationId": "SoftLayer_Hardware_Router::getNextBillingCycleBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNotesHistory": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNotesHistory/", + "operationId": "SoftLayer_Hardware_Router::getNotesHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Note" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNvRamCapacity": { + "get": { + "description": "The amount of non-volatile memory a piece of hardware has, measured in gigabytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNvRamCapacity/", + "operationId": "SoftLayer_Hardware_Router::getNvRamCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNvRamComponentModels": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getNvRamComponentModels/", + "operationId": "SoftLayer_Hardware_Router::getNvRamComponentModels", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getOperatingSystem": { + "get": { + "description": "Information regarding a piece of hardware's operating system.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getOperatingSystem/", + "operationId": "SoftLayer_Hardware_Router::getOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_OperatingSystem" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getOperatingSystemReferenceCode": { + "get": { + "description": "A hardware's operating system software description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getOperatingSystemReferenceCode/", + "operationId": "SoftLayer_Hardware_Router::getOperatingSystemReferenceCode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getOutboundBandwidthUsage": { + "get": { + "description": "The sum of all the outbound network traffic data for the last 30 days.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getOutboundBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Router::getOutboundBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getOutboundPublicBandwidthUsage": { + "get": { + "description": "The total public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getOutboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Router::getOutboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getParentBay": { + "get": { + "description": "Blade Bay", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getParentBay/", + "operationId": "SoftLayer_Hardware_Router::getParentBay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Blade" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getParentHardware": { + "get": { + "description": "Parent Hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getParentHardware/", + "operationId": "SoftLayer_Hardware_Router::getParentHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getPointOfPresenceLocation": { + "get": { + "description": "Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getPointOfPresenceLocation/", + "operationId": "SoftLayer_Hardware_Router::getPointOfPresenceLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getPowerComponents": { + "get": { + "description": "The power components for a hardware object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getPowerComponents/", + "operationId": "SoftLayer_Hardware_Router::getPowerComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Power_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getPowerSupply": { + "get": { + "description": "Information regarding a piece of hardware's power supply.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getPowerSupply/", + "operationId": "SoftLayer_Hardware_Router::getPowerSupply", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getPrimaryBackendIpAddress": { + "get": { + "description": "The hardware's primary private IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getPrimaryBackendIpAddress/", + "operationId": "SoftLayer_Hardware_Router::getPrimaryBackendIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getPrimaryBackendNetworkComponent": { + "get": { + "description": "Information regarding the hardware's primary back-end network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getPrimaryBackendNetworkComponent/", + "operationId": "SoftLayer_Hardware_Router::getPrimaryBackendNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getPrimaryIpAddress": { + "get": { + "description": "The hardware's primary public IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getPrimaryIpAddress/", + "operationId": "SoftLayer_Hardware_Router::getPrimaryIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getPrimaryNetworkComponent": { + "get": { + "description": "Information regarding the hardware's primary public network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getPrimaryNetworkComponent/", + "operationId": "SoftLayer_Hardware_Router::getPrimaryNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getPrivateNetworkOnlyFlag": { + "get": { + "description": "Whether the hardware only has access to the private network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getPrivateNetworkOnlyFlag/", + "operationId": "SoftLayer_Hardware_Router::getPrivateNetworkOnlyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getProcessorCoreAmount": { + "get": { + "description": "The total number of processor cores, summed from all processors that are attached to a piece of hardware", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getProcessorCoreAmount/", + "operationId": "SoftLayer_Hardware_Router::getProcessorCoreAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getProcessorPhysicalCoreAmount": { + "get": { + "description": "The total number of physical processor cores, summed from all processors that are attached to a piece of hardware", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getProcessorPhysicalCoreAmount/", + "operationId": "SoftLayer_Hardware_Router::getProcessorPhysicalCoreAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getProcessors": { + "get": { + "description": "Information regarding a piece of hardware's processors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getProcessors/", + "operationId": "SoftLayer_Hardware_Router::getProcessors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getRack": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getRack/", + "operationId": "SoftLayer_Hardware_Router::getRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getRaidControllers": { + "get": { + "description": "The RAID controllers contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getRaidControllers/", + "operationId": "SoftLayer_Hardware_Router::getRaidControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getRecentEvents": { + "get": { + "description": "Recent events that impact this hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getRecentEvents/", + "operationId": "SoftLayer_Hardware_Router::getRecentEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getRemoteManagementAccounts": { + "get": { + "description": "User credentials to issue commands and/or interact with the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getRemoteManagementAccounts/", + "operationId": "SoftLayer_Hardware_Router::getRemoteManagementAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_User" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getRemoteManagementComponent": { + "get": { + "description": "A hardware's associated remote management component. This is normally IPMI.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getRemoteManagementComponent/", + "operationId": "SoftLayer_Hardware_Router::getRemoteManagementComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getResourceConfigurations": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getResourceConfigurations/", + "operationId": "SoftLayer_Hardware_Router::getResourceConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Resource_Configuration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getResourceGroupMemberReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getResourceGroupMemberReferences/", + "operationId": "SoftLayer_Hardware_Router::getResourceGroupMemberReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group_Member" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getResourceGroupRoles": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getResourceGroupRoles/", + "operationId": "SoftLayer_Hardware_Router::getResourceGroupRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group_Role" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getResourceGroups": { + "get": { + "description": "The resource groups in which this hardware is a member.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getResourceGroups/", + "operationId": "SoftLayer_Hardware_Router::getResourceGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getRouters": { + "get": { + "description": "A hardware's routers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getRouters/", + "operationId": "SoftLayer_Hardware_Router::getRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getSecurityScanRequests": { + "get": { + "description": "Information regarding a piece of hardware's vulnerability scan requests.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getSecurityScanRequests/", + "operationId": "SoftLayer_Hardware_Router::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_Hardware_Router/{SoftLayer_Hardware_RouterID}/getServerRoom": { + "get": { + "description": "Information regarding the server room in which the hardware is located.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getServerRoom/", + "operationId": "SoftLayer_Hardware_Router::getServerRoom", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getServiceProvider": { + "get": { + "description": "Information regarding the piece of hardware's service provider.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getServiceProvider/", + "operationId": "SoftLayer_Hardware_Router::getServiceProvider", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Service_Provider" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getSoftwareComponents": { + "get": { + "description": "Information regarding a piece of hardware's installed software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getSoftwareComponents/", + "operationId": "SoftLayer_Hardware_Router::getSoftwareComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getSparePoolBillingItem": { + "get": { + "description": "Information regarding the billing item for a spare pool server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getSparePoolBillingItem/", + "operationId": "SoftLayer_Hardware_Router::getSparePoolBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getSshKeys": { + "get": { + "description": "SSH keys to be installed on the server during provisioning or an OS reload.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getSshKeys/", + "operationId": "SoftLayer_Hardware_Router::getSshKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getStorageGroups": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getStorageGroups/", + "operationId": "SoftLayer_Hardware_Router::getStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getStorageNetworkComponents": { + "get": { + "description": "A piece of hardware's private storage network components. [Deprecated]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getStorageNetworkComponents/", + "operationId": "SoftLayer_Hardware_Router::getStorageNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getTagReferences/", + "operationId": "SoftLayer_Hardware_Router::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getTopLevelLocation": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getTopLevelLocation/", + "operationId": "SoftLayer_Hardware_Router::getTopLevelLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getUpgradeRequest": { + "get": { + "description": "An account's associated upgrade request object, if any.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getUpgradeRequest/", + "operationId": "SoftLayer_Hardware_Router::getUpgradeRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Upgrade_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getUpgradeableActiveComponents": { + "get": { + "description": "A piece of hardware's active upgradeable physical components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getUpgradeableActiveComponents/", + "operationId": "SoftLayer_Hardware_Router::getUpgradeableActiveComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getUplinkHardware": { + "get": { + "description": "The network device connected to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getUplinkHardware/", + "operationId": "SoftLayer_Hardware_Router::getUplinkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getUplinkNetworkComponents": { + "get": { + "description": "Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getUplinkNetworkComponents/", + "operationId": "SoftLayer_Hardware_Router::getUplinkNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getUserData": { + "get": { + "description": "An array containing a single string of custom user data for a hardware order. Max size is 16 kb.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getUserData/", + "operationId": "SoftLayer_Hardware_Router::getUserData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getVirtualChassis": { + "get": { + "description": "Information regarding the virtual chassis for a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getVirtualChassis/", + "operationId": "SoftLayer_Hardware_Router::getVirtualChassis", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getVirtualChassisSiblings": { + "get": { + "description": "Information regarding the virtual chassis siblings for a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getVirtualChassisSiblings/", + "operationId": "SoftLayer_Hardware_Router::getVirtualChassisSiblings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getVirtualHost": { + "get": { + "description": "A piece of hardware's virtual host record.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getVirtualHost/", + "operationId": "SoftLayer_Hardware_Router::getVirtualHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getVirtualLicenses": { + "get": { + "description": "Information regarding a piece of hardware's virtual software licenses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getVirtualLicenses/", + "operationId": "SoftLayer_Hardware_Router::getVirtualLicenses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_VirtualLicense" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getVirtualRack": { + "get": { + "description": "Information regarding the bandwidth allotment to which a piece of hardware belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getVirtualRack/", + "operationId": "SoftLayer_Hardware_Router::getVirtualRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getVirtualRackId": { + "get": { + "description": "The name of the bandwidth allotment belonging to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getVirtualRackId/", + "operationId": "SoftLayer_Hardware_Router::getVirtualRackId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getVirtualRackName": { + "get": { + "description": "The name of the bandwidth allotment belonging to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getVirtualRackName/", + "operationId": "SoftLayer_Hardware_Router::getVirtualRackName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getVirtualizationPlatform": { + "get": { + "description": "A piece of hardware's virtualization platform software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Router/getVirtualizationPlatform/", + "operationId": "SoftLayer_Hardware_Router::getVirtualizationPlatform", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/createObject": { + "post": { + "description": "\n \ncreateObject() enables the creation of servers on an account. This \nmethod is a simplified alternative to interacting with the ordering system directly. \n\n\nIn order to create a server, a template object must be sent in with a few required \nvalues. \n\n\nWhen this method returns an order will have been placed for a server of the specified configuration. \n\n\nTo determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]], \nchecking the 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 \n
    Hostname for the server.
      \n
    • Required
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
  • domain \n
    Domain for the server.
      \n
    • Required
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
  • processorCoreAmount \n
    The number of logical CPU cores to allocate.
      \n
    • Required
      • \n
    • Type - int
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n
    \n
    • \n
  • memoryCapacity \n
    The amount of memory to allocate in gigabytes.
      \n
    • Required
      • \n
    • Type - int
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n
    \n
    • \n
  • hourlyBillingFlag \n
    Specifies 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
    • \n
  • operatingSystemReferenceCode \n
    An 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
    • \n
  • datacenter.name \n
    Specifies which datacenter the server is to be provisioned in.
      \n
    • Required
      • \n
    • Type - string
      • \n
    • The datacenter property is a [[SoftLayer_Location (type)|location]] structure with the name field set.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"datacenter\": { \n \"name\": \"dal05\" \n } \n} \n
    \n
    • \n
  • networkComponents.maxSpeed \n
    Specifies 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 networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The maxSpeed property 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 { \n \"networkComponents\": [ \n { \n \"maxSpeed\": 1000 \n } \n ] \n} \n
    \n
    • \n
  • networkComponents.redundancyEnabledFlag \n
    Specifies whether or not the server's network components should be in redundancy groups.
      \n
    • Optional
      • \n
    • Type - bool
      • \n
    • Default - false
      • \n
    • Description - The networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the redundancyEnabledFlag property is true the server's network components will be in redundancy groups.
      • \n
    \n { \n \"networkComponents\": [ \n { \n \"redundancyEnabledFlag\": false \n } \n ] \n} \n
    \n
    • \n
  • privateNetworkOnlyFlag \n
    Specifies 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
    • \n
  • primaryNetworkComponent.networkVlan.id \n
    Specifies the network vlan which is to be used for the frontend interface of the server.
      \n
    • Optional
      • \n
    • Type - int
      • \n
    • Description - The primaryNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the frontend network vlan of the server.
      • \n
    \n { \n \"primaryNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 1 \n } \n } \n} \n
    \n
    • \n
  • primaryBackendNetworkComponent.networkVlan.id \n
    Specifies the network vlan which is to be used for the backend interface of the server.
      \n
    • Optional
      • \n
    • Type - int
      • \n
    • Description - The primaryBackendNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the backend network vlan of the server.
      • \n
    \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 fixedConfigurationPreset property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The keyName property must be set to specify preset to use.
      • \n
    • If a fixed configuration preset is used processorCoreAmount, memoryCapacity and hardDrives properties must not be set.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"fixedConfigurationPreset\": { \n \"keyName\": \"SOME_KEY_NAME\" \n } \n} \n
    \n
    • \n
  • userData.value \n
    Arbitrary data to be made available to the server.
      \n
    • Optional
      • \n
    • Type - string
      • \n
    • Description - The userData property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the value property 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 { \n \"userData\": [ \n { \n \"value\": \"someValue\" \n } \n ] \n} \n
    \n
    • \n
  • hardDrives \n
    Hard 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 hardDrives property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures. \n
    • Each hard drive must specify the capacity property.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"hardDrives\": [ \n { \n \"capacity\": 500 \n } \n ] \n} \n
    \n
    • \n
  • sshKeys \n
    SSH 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 sshKeys property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the id property 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 { \n \"sshKeys\": [ \n { \n \"id\": 123 \n } \n ] \n} \n
    \n
    • \n
  • postInstallScriptUri \n
    Specifies the uri location of the script to be downloaded and run after installation is complete.
      \n
    • Optional
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
\n\n\n

REST Example

\ncurl -X POST -d '{ \n \"parameters\":[ \n { \n \"hostname\": \"host1\", \n \"domain\": \"example.com\", \n \"processorCoreAmount\": 2, \n \"memoryCapacity\": 2, \n \"hourlyBillingFlag\": true, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\" \n } \n ] \n}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json \n \nHTTP/1.1 201 Created \nLocation: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject \n\n\n{ \n \"accountId\": 232298, \n \"bareMetalInstanceFlag\": null, \n \"domain\": \"example.com\", \n \"hardwareStatusId\": null, \n \"hostname\": \"host1\", \n \"id\": null, \n \"serviceProviderId\": null, \n \"serviceProviderResourceId\": null, \n \"globalIdentifier\": \"f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5\", \n \"hourlyBillingFlag\": true, \n \"memoryCapacity\": 2, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\", \n \"processorCoreAmount\": 2 \n} \n ", + "summary": "Create a new server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/createObject/", + "operationId": "SoftLayer_Hardware_SecurityModule::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_SecurityModule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Hardware_SecurityModule record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getObject/", + "operationId": "SoftLayer_Hardware_SecurityModule::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_SecurityModule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/activatePrivatePort": { + "get": { + "description": "Activate a server's private network interface to the maximum available speed. This operation is an alias for [[SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed]] with a $newSpeed of -1 and a $redundancy of \"redundant\" or unspecified (which results in the best available redundancy state). \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending. ", + "summary": "Activate a server's private network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/activatePrivatePort/", + "operationId": "SoftLayer_Hardware_SecurityModule::activatePrivatePort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/activatePublicPort": { + "get": { + "description": "Activate a server's public network interface to the maximum available speed. This operation is an alias for [[SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed]] with a $newSpeed of -1 and a $redundancy of \"redundant\" or unspecified (which results in the best available redundancy state). \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending. ", + "summary": "Activate a server's public network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/activatePublicPort/", + "operationId": "SoftLayer_Hardware_SecurityModule::activatePublicPort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/bootToRescueLayer": { + "post": { + "description": "The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server. ", + "summary": "Initiates the Rescue Kernel to bring a server online to troubleshoot system problems.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/bootToRescueLayer/", + "operationId": "SoftLayer_Hardware_SecurityModule::bootToRescueLayer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/changeRedfishPowerState": { + "post": { + "description": "Changes the power state for the server. The server's power status is changed from its remote management card. ", + "summary": "Changes server's power state using Redfish", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/changeRedfishPowerState/", + "operationId": "SoftLayer_Hardware_SecurityModule::changeRedfishPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/createFirmwareReflashTransaction": { + "post": { + "description": "You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress. \n\nIn the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware reflash on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareReflashTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule::createFirmwareReflashTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/createFirmwareUpdateTransaction": { + "post": { + "description": "You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware updates on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareUpdateTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule::createFirmwareUpdateTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/createHyperThreadingUpdateTransaction": { + "post": { + "description": "You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress. \n\nIn the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs BIOS update on the server to change the hyper-threading configuration.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/createHyperThreadingUpdateTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule::createHyperThreadingUpdateTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/createPostSoftwareInstallTransaction": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/createPostSoftwareInstallTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule::createPostSoftwareInstallTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/editObject": { + "post": { + "description": "Edit a server's properties ", + "summary": "Edit a server's properties", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/editObject/", + "operationId": "SoftLayer_Hardware_SecurityModule::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBackendBandwidthUsage": { + "post": { + "description": "Use this method to return an array of private bandwidth utilization records between a given date range. \n\nThis method represents the NEW version of getFrontendBandwidthUse ", + "summary": "Retrieves public bandwidth usage records.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBackendBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthForDateRange/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBandwidthForDateRange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBandwidthImage": { + "post": { + "description": "Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image. ", + "summary": "Retrieve a bandwidth image and textual description of that image for this server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthImage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBandwidthImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBootModeOptions": { + "get": { + "description": "Retrieve the valid boot modes for this server ", + "summary": "Retrieve the valid boot modes for this server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBootModeOptions/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBootModeOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getCurrentBenchmarkCertificationResultFile": { + "get": { + "description": "Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception. ", + "summary": "Get the file for the current benchmark certification result, if it exists.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBenchmarkCertificationResultFile/", + "operationId": "SoftLayer_Hardware_SecurityModule::getCurrentBenchmarkCertificationResultFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getFirewallProtectableSubnets": { + "get": { + "description": "Get the subnets associated with this server that are protectable by a network component firewall. ", + "summary": "Get the subnets associated with this server that are protectable by a network component firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallProtectableSubnets/", + "operationId": "SoftLayer_Hardware_SecurityModule::getFirewallProtectableSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getFrontendBandwidthUsage": { + "post": { + "description": "Use this method to return an array of public bandwidth utilization records between a given date range. \n\nThis method represents the NEW version of getFrontendBandwidthUse ", + "summary": "Retrieves public bandwidth usage records.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getFrontendBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/getHardwareByIpAddress": { + "post": { + "description": "Retrieve a server by searching for the primary IP address. ", + "summary": "Retrieve a SoftLayer_Hardware_Server object by IP address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareByIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHardwareByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Server" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getItemPricesFromSoftwareDescriptions": { + "post": { + "description": "Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description", + "summary": "Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getItemPricesFromSoftwareDescriptions/", + "operationId": "SoftLayer_Hardware_SecurityModule::getItemPricesFromSoftwareDescriptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getManagementNetworkComponent": { + "get": { + "description": "Retrieve the remote management network component attached with this server. ", + "summary": "Retrieve a server's management network component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getManagementNetworkComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getManagementNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkComponentFirewallProtectableIpAddresses": { + "get": { + "description": "Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this server. Please use getFirewallProtectableSubnets to get all protectable subnets. ", + "summary": "Get the IP addresses associated with this server that are protectable by a network component firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponentFirewallProtectableIpAddresses/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkComponentFirewallProtectableIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPMInfo": { + "get": { + "description": "Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires. ", + "summary": "Retrieve a server's hardware state via its internal sensors.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPMInfo/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPMInfo", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_PmInfo" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrimaryDriveSize": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryDriveSize/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrimaryDriveSize", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrivateBandwidthDataSummary": { + "get": { + "description": "Retrieve a brief summary of a server's private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period. ", + "summary": "Retrieve a server's private bandwidth usage summary", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthDataSummary/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrivateBandwidthDataSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Bandwidth_Data_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrivateBandwidthGraphImage": { + "post": { + "description": "Retrieve a graph of a server's private network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image ", + "summary": "Retrieve a graph of a server's private network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthGraphImage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrivateBandwidthGraphImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrivateNetworkComponent": { + "get": { + "description": "Retrieve the private network component attached with this server. ", + "summary": "Retrieve a server's private network component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrivateNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrivateVlan": { + "get": { + "description": "Retrieve the backend VLAN for the primary IP address of the server ", + "summary": "Retrieve the backend VLAN for the primary IP address of the server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlan/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrivateVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress": { + "post": { + "description": "\n*** DEPRECATED ***\nRetrieve a backend network VLAN by searching for an IP address ", + "summary": "Retrieve a backend network VLAN by searching for an IP address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrivateVlanByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getProvisionDate": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getProvisionDate/", + "operationId": "SoftLayer_Hardware_SecurityModule::getProvisionDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPublicBandwidthDataSummary": { + "get": { + "description": "Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period. ", + "summary": "Retrieve a server's public bandwidth usage summary", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthDataSummary/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPublicBandwidthDataSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Bandwidth_Data_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPublicBandwidthGraphImage": { + "post": { + "description": "Retrieve a graph of a server's public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY. ", + "summary": "Retrieve a graph of a server's public network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthGraphImage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPublicBandwidthGraphImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPublicBandwidthTotal": { + "post": { + "description": "Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware. ", + "summary": "Retrieve total number of public bytes used by a server over time period specified.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthTotal/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPublicBandwidthTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPublicNetworkComponent": { + "get": { + "description": "Retrieve a SoftLayer server's public network component. Some servers are only connected to the private network and may not have a public network component. In that case getPublicNetworkComponent returns a null object. ", + "summary": "Retrieve a server's public network component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPublicNetworkComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPublicNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPublicVlan": { + "get": { + "description": "Retrieve the frontend VLAN for the primary IP address of the server ", + "summary": "Retrieve the frontend VLAN for the primary IP address of the server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlan/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPublicVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/getPublicVlanByHostname": { + "post": { + "description": "Retrieve the frontend network Vlan by searching the hostname of a server ", + "summary": "Retrieve the frontend VLAN by a server's hostname.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlanByHostname/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPublicVlanByHostname", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRedfishPowerState": { + "get": { + "description": "Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'. ", + "summary": "Retrieves server's power state using Redfish", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRedfishPowerState/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRedfishPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getReverseDomainRecords": { + "get": { + "description": "Retrieve the reverse domain records associated with this server. ", + "summary": "Retrieve the reverse domain records associated with a server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getReverseDomainRecords/", + "operationId": "SoftLayer_Hardware_SecurityModule::getReverseDomainRecords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Dns_Domain" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getSensorData": { + "get": { + "description": "Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires. ", + "summary": "Retrieve a server's hardware state via its internal sensors.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getSensorData/", + "operationId": "SoftLayer_Hardware_SecurityModule::getSensorData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_SensorReading" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getSensorDataWithGraphs": { + "get": { + "description": "Retrieves the raw data returned from the server's remote management card. For more details of what is returned please refer to the getSensorData method. Along with the raw data, graphs for the cpu and system temperatures and fan speeds are also returned. ", + "summary": "Retrieve server's temperature and fan speed graphs as well the sensor raw data.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getSensorDataWithGraphs/", + "operationId": "SoftLayer_Hardware_SecurityModule::getSensorDataWithGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getServerDetails": { + "get": { + "description": "Retrieve a server's hardware components, software, and network components. getServerDetails is an aggregation function that combines the results of [[SoftLayer_Hardware_Server::getComponents]], [[SoftLayer_Hardware_Server::getSoftware]], and [[SoftLayer_Hardware_Server::getNetworkComponents]] in a single container. ", + "summary": "Retrieve a server's hardware components, software, and network components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getServerDetails/", + "operationId": "SoftLayer_Hardware_SecurityModule::getServerDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Details" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getServerFanSpeedGraphs": { + "get": { + "description": "Retrieve the server's fan speeds and displays them using tachometer graphs. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it. ", + "summary": "Retrieve server's fan speed graphs.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getServerFanSpeedGraphs/", + "operationId": "SoftLayer_Hardware_SecurityModule::getServerFanSpeedGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getServerPowerState": { + "get": { + "description": "Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'. ", + "summary": "Retrieves server's power state", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getServerPowerState/", + "operationId": "SoftLayer_Hardware_SecurityModule::getServerPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getServerTemperatureGraphs": { + "get": { + "description": "Retrieve the server's temperature and displays them using thermometer graphs. Temperatures retrieved are CPU(s) and system temperatures. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it. ", + "summary": "Retrieve server's temperature graphs", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getServerTemperatureGraphs/", + "operationId": "SoftLayer_Hardware_SecurityModule::getServerTemperatureGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getValidBlockDeviceTemplateGroups": { + "post": { + "description": "This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images. ", + "summary": "Return a list of valid block device template groups based on this host", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getValidBlockDeviceTemplateGroups/", + "operationId": "SoftLayer_Hardware_SecurityModule::getValidBlockDeviceTemplateGroups", + "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_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getWindowsUpdateAvailableUpdates": { + "get": { + "description": "Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default. ", + "summary": "Retrieve a list of Windows updates available to a server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateAvailableUpdates/", + "operationId": "SoftLayer_Hardware_SecurityModule::getWindowsUpdateAvailableUpdates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getWindowsUpdateInstalledUpdates": { + "get": { + "description": "Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default. ", + "summary": "Retrieve a list of Windows updates installed on a server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateInstalledUpdates/", + "operationId": "SoftLayer_Hardware_SecurityModule::getWindowsUpdateInstalledUpdates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getWindowsUpdateStatus": { + "get": { + "description": "This method returns an update status record for this server. That record will specify if the server is missing updates, or has updates that must be reinstalled or require a reboot to go into affect. ", + "summary": "Retrieve a server's Windows update synchronization status", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateStatus/", + "operationId": "SoftLayer_Hardware_SecurityModule::getWindowsUpdateStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/initiateIderaBareMetalRestore": { + "get": { + "description": "Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup. ", + "summary": "Initiate an Idera bare metal restore for the server tied to an Idera Server Backup", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/initiateIderaBareMetalRestore/", + "operationId": "SoftLayer_Hardware_SecurityModule::initiateIderaBareMetalRestore", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/initiateR1SoftBareMetalRestore": { + "get": { + "description": "R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup. ", + "summary": "Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/initiateR1SoftBareMetalRestore/", + "operationId": "SoftLayer_Hardware_SecurityModule::initiateR1SoftBareMetalRestore", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/isBackendPingable": { + "get": { + "description": "Issues a ping command and returns the success (true) or failure (false) of the ping command. ", + "summary": "Verifies if a server's backend ip address is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/isBackendPingable/", + "operationId": "SoftLayer_Hardware_SecurityModule::isBackendPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/isPingable": { + "get": { + "description": "Issues a ping command and returns the success (true) or failure (false) of the ping command. ", + "summary": "Verifies if server is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/isPingable/", + "operationId": "SoftLayer_Hardware_SecurityModule::isPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/isWindowsServer": { + "get": { + "description": "Determine if the server runs any version of the Microsoft Windows operating systems. Return ''true'' if it does and ''false if otherwise. ", + "summary": "Determine if a server runs the Microsoft Windows operating system.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/isWindowsServer/", + "operationId": "SoftLayer_Hardware_SecurityModule::isWindowsServer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/massFirmwareReflash": { + "post": { + "description": "You can launch firmware reflashes by selecting from your server list. It will bring your server offline for approximately 60 minutes while the reflashes are in progress. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be contact you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware reflashes on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareReflash/", + "operationId": "SoftLayer_Hardware_SecurityModule::massFirmwareReflash", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/massFirmwareUpdate": { + "post": { + "description": "You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware updates on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareUpdate/", + "operationId": "SoftLayer_Hardware_SecurityModule::massFirmwareUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/massHyperThreadingUpdate": { + "post": { + "description": "You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the updates are in progress. \n\nIn the event of a hardware failure during this update our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be in contact with you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware reflashes on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/massHyperThreadingUpdate/", + "operationId": "SoftLayer_Hardware_SecurityModule::massHyperThreadingUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/massReloadOperatingSystem": { + "post": { + "description": "Reloads current or customer specified operating system configuration. \n\nThis service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server. \n\nAs a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record. \n\nThe reload will take AT MINIMUM 66 minutes. ", + "summary": "Reloads operating system configuration on a set of hardware Ids.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/massReloadOperatingSystem/", + "operationId": "SoftLayer_Hardware_SecurityModule::massReloadOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/massSparePool": { + "post": { + "description": "The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program. ", + "summary": "Allows multiple servers to be added to or removed from the spare pool.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/massSparePool/", + "operationId": "SoftLayer_Hardware_SecurityModule::massSparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/ping": { + "get": { + "description": "Issues a ping command to the server and returns the ping response. ", + "summary": "Issues ping command.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/ping/", + "operationId": "SoftLayer_Hardware_SecurityModule::ping", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/populateServerRam": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/populateServerRam/", + "operationId": "SoftLayer_Hardware_SecurityModule::populateServerRam", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/powerCycle": { + "get": { + "description": "Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Issues power cycle to server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/powerCycle/", + "operationId": "SoftLayer_Hardware_SecurityModule::powerCycle", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/powerOff": { + "get": { + "description": "This method will power off the server via the server's remote management card. ", + "summary": "Power off server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/powerOff/", + "operationId": "SoftLayer_Hardware_SecurityModule::powerOff", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/powerOn": { + "get": { + "description": "Power on server via its remote management card. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Power on server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/powerOn/", + "operationId": "SoftLayer_Hardware_SecurityModule::powerOn", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/rebootDefault": { + "get": { + "description": "Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card. If the reset (soft reboot) attempt is unsuccessful, a power cycle command will be issued via the powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Reboot the server via the default method.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/rebootDefault/", + "operationId": "SoftLayer_Hardware_SecurityModule::rebootDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/rebootHard": { + "get": { + "description": "Reboot the server by issuing a cycle command to the server's remote management card. This is equivalent to pressing the 'Reset' button on the server. This command is issued immediately and will not wait for processes to shutdown. After this command is issued, the server may take a few moments to boot up as server may run system disks checks. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Reboot the server via \"hard\" reboot.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/rebootHard/", + "operationId": "SoftLayer_Hardware_SecurityModule::rebootHard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/rebootSoft": { + "get": { + "description": "Reboot the server by issuing a reset command to the server's remote management card. This is a graceful reboot. The servers will allow all process to shutdown gracefully before rebooting. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Reboot the server via gracefully (soft reboot).", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/rebootSoft/", + "operationId": "SoftLayer_Hardware_SecurityModule::rebootSoft", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/reloadCurrentOperatingSystemConfiguration": { + "post": { + "description": "Reloads current operating system configuration. \n\nThis service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server. \n\nAs a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record. \n\nThe reload will take AT MINIMUM 66 minutes. ", + "summary": "Reloads current operating system configuration.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/reloadCurrentOperatingSystemConfiguration/", + "operationId": "SoftLayer_Hardware_SecurityModule::reloadCurrentOperatingSystemConfiguration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/reloadOperatingSystem": { + "post": { + "description": "Reloads current or customer specified operating system configuration. \n\nThis service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server. \n\nAs a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record. \n\nThe reload will take AT MINIMUM 66 minutes. ", + "summary": "Reloads operating system configuration.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/reloadOperatingSystem/", + "operationId": "SoftLayer_Hardware_SecurityModule::reloadOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/runPassmarkCertificationBenchmark": { + "get": { + "description": "You can launch a new Passmark hardware test by selecting from your server list. It will bring your server offline for approximately 20 minutes while the testing is in progress, and will publish a certificate with the results to your hardware details page. \n\nWhile the hard drives are tested for the initial deployment, the Passmark Certificate utility will not test the hard drives on your live server. This is to ensure that no data is overwritten. If you would like to test the server's hard drives, you can have the full Passmark suite installed to your server free of charge through a new Support ticket. \n\nWhile the test itself does not overwrite any data on the server, it is recommended that you make full off-server backups of all data prior to launching the test. The Passmark hardware test is designed to force any latent hardware issues to the surface, so hardware failure is possible. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs a hardware stress test on the server to obtain a Passmark Certification.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/runPassmarkCertificationBenchmark/", + "operationId": "SoftLayer_Hardware_SecurityModule::runPassmarkCertificationBenchmark", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/setOperatingSystemPassword": { + "post": { + "description": "Changes the password that we have stored in our database for a servers' Operating System", + "summary": "Changes the password stored in our system for a servers' Operating System", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/setOperatingSystemPassword/", + "operationId": "SoftLayer_Hardware_SecurityModule::setOperatingSystemPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/setPrivateNetworkInterfaceSpeed": { + "post": { + "description": "Set the private network interface speed and redundancy configuration. \n\nPossible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available. \n\nIf specified, possible $redundancy values are either \"redundant\" or \"degraded\". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. \"redundant\" indicates all available interfaces should be active. \"degraded\" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending. \n\n

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\".
After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1. ", + "summary": "Set the speed and redundancy configuration of a server's private network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/setPrivateNetworkInterfaceSpeed/", + "operationId": "SoftLayer_Hardware_SecurityModule::setPrivateNetworkInterfaceSpeed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/setPublicNetworkInterfaceSpeed": { + "post": { + "description": "Set the public network interface speed and redundancy configuration. \n\nPossible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available. \n\nIf specified, possible $redundancy values are either \"redundant\" or \"degraded\". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. \"redundant\" indicates all available interfaces should be active. \"degraded\" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending. \n\n

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\".
After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1. ", + "summary": "Set the speed and redundancy configuration of a server's public network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/setPublicNetworkInterfaceSpeed/", + "operationId": "SoftLayer_Hardware_SecurityModule::setPublicNetworkInterfaceSpeed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/setUserMetadata": { + "post": { + "description": "Sets the data that will be written to the configuration drive. ", + "summary": "Sets the server's user metadata value.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/setUserMetadata/", + "operationId": "SoftLayer_Hardware_SecurityModule::setUserMetadata", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/shutdownPrivatePort": { + "get": { + "description": "Disconnect a server's private network interface. This operation is an alias for calling [[SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed]] with a $newSpeed of 0 and unspecified $redundancy. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending. ", + "summary": "Disconnect a server's private network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPrivatePort/", + "operationId": "SoftLayer_Hardware_SecurityModule::shutdownPrivatePort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/shutdownPublicPort": { + "get": { + "description": "Disconnect a server's public network interface. This operation is an alias for [[SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed]] with a $newSpeed of 0 and unspecified $redundancy. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending. ", + "summary": "Disconnect a server's public network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPublicPort/", + "operationId": "SoftLayer_Hardware_SecurityModule::shutdownPublicPort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/sparePool": { + "post": { + "description": "The ability to place bare metal servers in a state where they are powered down, and ports closed yet still allocated to the customer as a part of the Spare Pool program. ", + "summary": "Allows servers to be added to or removed from the spare pool.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/sparePool/", + "operationId": "SoftLayer_Hardware_SecurityModule::sparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/testRaidAlertService": { + "get": { + "description": "Test the RAID Alert service by sending the service a request to store a test email for this server. The server must have an account ID and MAC address. A RAID controller must also be installed. ", + "summary": "Tests the RAID Alert service.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/testRaidAlertService/", + "operationId": "SoftLayer_Hardware_SecurityModule::testRaidAlertService", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/toggleManagementInterface": { + "post": { + "description": "Attempt to toggle the IPMI interface. If there is an active transaction on the server, it will throw an exception. This method creates a job to toggle the interface. It is not instant. ", + "summary": "Toggle the IPMI interface on and off.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/toggleManagementInterface/", + "operationId": "SoftLayer_Hardware_SecurityModule::toggleManagementInterface", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/updateIpmiPassword": { + "post": { + "description": "This method will update the root IPMI password on this SoftLayer_Hardware. ", + "summary": "Update the root IPMI user password ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/updateIpmiPassword/", + "operationId": "SoftLayer_Hardware_SecurityModule::updateIpmiPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/validatePartitionsForOperatingSystem": { + "post": { + "description": "Validates a collection of partitions for an operating system", + "summary": "Validates a collection of partitions for an operating system", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/validatePartitionsForOperatingSystem/", + "operationId": "SoftLayer_Hardware_SecurityModule::validatePartitionsForOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/validateSecurityLevel": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/validateSecurityLevel/", + "operationId": "SoftLayer_Hardware_SecurityModule::validateSecurityLevel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/allowAccessToNetworkStorage": { + "post": { + "description": "This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control. ", + "summary": "Allow access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule::allowAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/allowAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Allow access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorageList/", + "operationId": "SoftLayer_Hardware_SecurityModule::allowAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/captureImage": { + "post": { + "description": "Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image. ", + "summary": "Captures an Image of the hard disk on the physical machine.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/captureImage/", + "operationId": "SoftLayer_Hardware_SecurityModule::captureImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/deleteObject": { + "get": { + "description": "\nThis method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns. ", + "summary": "Delete a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/deleteObject/", + "operationId": "SoftLayer_Hardware_SecurityModule::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/deleteSoftwareComponentPasswords": { + "post": { + "description": "Delete software component passwords. ", + "summary": "Delete software component passwords.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/deleteSoftwareComponentPasswords/", + "operationId": "SoftLayer_Hardware_SecurityModule::deleteSoftwareComponentPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/deleteTag": { + "post": { + "description": "Delete an existing tag. If there are any references on the tag, an exception will be thrown. ", + "summary": "Delete a tag", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/deleteTag/", + "operationId": "SoftLayer_Hardware_SecurityModule::deleteTag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/editSoftwareComponentPasswords": { + "post": { + "description": "Edit the properties of a software component password such as the username, password, and notes. ", + "summary": "Edit the properties of software component passwords.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/editSoftwareComponentPasswords/", + "operationId": "SoftLayer_Hardware_SecurityModule::editSoftwareComponentPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/executeRemoteScript": { + "post": { + "description": "Download and run remote script from uri on the hardware.", + "summary": "Download and run remote script from uri on the hardware. Requires https for script to be executed after download. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/executeRemoteScript/", + "operationId": "SoftLayer_Hardware_SecurityModule::executeRemoteScript", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/findByIpAddress": { + "post": { + "description": "The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned. ", + "summary": "Find hardware by its primary public or private IP (ipv4) address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/findByIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule::findByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/generateOrderTemplate": { + "post": { + "description": "\nObtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]]. \n\n\nThis is primarily useful when there is a necessity to confirm the price which will be charged for an order. \n\n\nSee [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter. ", + "summary": "Obtain an order container for a given template object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/generateOrderTemplate/", + "operationId": "SoftLayer_Hardware_SecurityModule::generateOrderTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAttachedNetworkStorages": { + "post": { + "description": "This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAttachedNetworkStorages/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAttachedNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAvailableBillingTermChangePrices": { + "get": { + "description": "Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers. ", + "summary": "Retrieves a list of available term prices available to this of hardware. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableBillingTermChangePrices/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAvailableBillingTermChangePrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAvailableNetworkStorages": { + "post": { + "description": "This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableNetworkStorages/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAvailableNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBackendIncomingBandwidth": { + "post": { + "description": "The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes. ", + "summary": "Retrieve the amount of incoming private network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBackendIncomingBandwidth/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBackendIncomingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBackendOutgoingBandwidth": { + "post": { + "description": "The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes. ", + "summary": "Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBackendOutgoingBandwidth/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBackendOutgoingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getComponentDetailsXML": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getComponentDetailsXML/", + "operationId": "SoftLayer_Hardware_SecurityModule::getComponentDetailsXML", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/getCreateObjectOptions": { + "get": { + "description": "\nThere are many options that may be provided while ordering a server, this method can be used to determine what these options are. \n\n\nDetailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]]. ", + "summary": "Determine options available when creating a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getCreateObjectOptions/", + "operationId": "SoftLayer_Hardware_SecurityModule::getCreateObjectOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Configuration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getCurrentBillingDetail": { + "get": { + "description": "Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage. ", + "summary": "<< EOT", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingDetail/", + "operationId": "SoftLayer_Hardware_SecurityModule::getCurrentBillingDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getCurrentBillingTotal": { + "get": { + "description": "Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware. ", + "summary": "Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingTotal/", + "operationId": "SoftLayer_Hardware_SecurityModule::getCurrentBillingTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDailyAverage": { + "post": { + "description": "The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day. ", + "summary": "calculate the average daily network traffic used by a server in gigabytes.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDailyAverage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDailyAverage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getFrontendIncomingBandwidth": { + "post": { + "description": "The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB). ", + "summary": "Retrieve the amount of incoming public network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendIncomingBandwidth/", + "operationId": "SoftLayer_Hardware_SecurityModule::getFrontendIncomingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getFrontendOutgoingBandwidth": { + "post": { + "description": "The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB). ", + "summary": "Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendOutgoingBandwidth/", + "operationId": "SoftLayer_Hardware_SecurityModule::getFrontendOutgoingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHourlyBandwidth": { + "post": { + "description": "The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of \n\n'02/01/2008 0:00' \n\nresults in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time). \n\nFor data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware. ", + "summary": "Retrieves bandwidth hourly over a 24-hour period for the specified hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBandwidth/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHourlyBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrivateBandwidthData": { + "post": { + "description": "Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. ", + "summary": "Retrieve a graph of a server's private network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthData/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrivateBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPublicBandwidthData": { + "post": { + "description": "Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. ", + "summary": "Retrieve a graph of a server's public network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthData/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPublicBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getTransactionHistory": { + "get": { + "description": "\nThis method will query transaction history for a piece of hardware. ", + "summary": "Get transaction history for a piece of hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getTransactionHistory/", + "operationId": "SoftLayer_Hardware_SecurityModule::getTransactionHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getUpgradeItemPrices": { + "get": { + "description": "Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs. ", + "summary": "Retrieve a list of upgradeable items available to a piece of hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeItemPrices/", + "operationId": "SoftLayer_Hardware_SecurityModule::getUpgradeItemPrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/importVirtualHost": { + "get": { + "description": "The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.", + "summary": "attempt to import the host record for the virtualization platform running on a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/importVirtualHost/", + "operationId": "SoftLayer_Hardware_SecurityModule::importVirtualHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/refreshDeviceStatus": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/refreshDeviceStatus/", + "operationId": "SoftLayer_Hardware_SecurityModule::refreshDeviceStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/removeAccessToNetworkStorage": { + "post": { + "description": "This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control. ", + "summary": "Remove access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule::removeAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/removeAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Remove access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorageList/", + "operationId": "SoftLayer_Hardware_SecurityModule::removeAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/removeTags": { + "post": { + "description": null, + "summary": "Remove a tag reference", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/removeTags/", + "operationId": "SoftLayer_Hardware_SecurityModule::removeTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/setTags": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/setTags/", + "operationId": "SoftLayer_Hardware_SecurityModule::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getActiveNetworkFirewallBillingItem": { + "get": { + "description": "The billing item for a server's attached network firewall.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkFirewallBillingItem/", + "operationId": "SoftLayer_Hardware_SecurityModule::getActiveNetworkFirewallBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getActiveTickets": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTickets/", + "operationId": "SoftLayer_Hardware_SecurityModule::getActiveTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getActiveTransaction": { + "get": { + "description": "Transaction currently running for server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule::getActiveTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getActiveTransactions": { + "get": { + "description": "Any active transaction(s) that are currently running for the server (example: os reload).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransactions/", + "operationId": "SoftLayer_Hardware_SecurityModule::getActiveTransactions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAvailableMonitoring": { + "get": { + "description": "An object that stores the maximum level for the monitoring query types and response types.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableMonitoring/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAvailableMonitoring", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAverageDailyBandwidthUsage": { + "get": { + "description": "The average daily total bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAverageDailyBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAverageDailyPrivateBandwidthUsage": { + "get": { + "description": "The average daily private bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAverageDailyPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBillingCycleBandwidthUsage": { + "get": { + "description": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCycleBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBillingCycleBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBillingCyclePrivateBandwidthUsage": { + "get": { + "description": "The raw private bandwidth usage data for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBillingCyclePrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBillingCyclePublicBandwidthUsage": { + "get": { + "description": "The raw public bandwidth usage data for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBillingCyclePublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBiosPasswordNullFlag": { + "get": { + "description": "Determine if BIOS password should be left as null.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBiosPasswordNullFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBiosPasswordNullFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getCaptureEnabledFlag": { + "get": { + "description": "Determine if the server is able to be image captured. If unable to image capture a reason will be provided.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getCaptureEnabledFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getCaptureEnabledFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_CaptureEnabled" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getContainsSolidStateDrivesFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getContainsSolidStateDrivesFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getContainsSolidStateDrivesFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getControlPanel": { + "get": { + "description": "A server's control panel.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getControlPanel/", + "operationId": "SoftLayer_Hardware_SecurityModule::getControlPanel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_ControlPanel" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getCost": { + "get": { + "description": "The total cost of a server, measured in US Dollars ($USD).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getCost/", + "operationId": "SoftLayer_Hardware_SecurityModule::getCost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getCurrentBandwidthSummary": { + "get": { + "description": "An object that provides commonly used bandwidth summary components for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBandwidthSummary/", + "operationId": "SoftLayer_Hardware_SecurityModule::getCurrentBandwidthSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getCustomerInstalledOperatingSystemFlag": { + "get": { + "description": "Indicates if a server has a Customer Installed OS", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerInstalledOperatingSystemFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getCustomerInstalledOperatingSystemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getCustomerOwnedFlag": { + "get": { + "description": "Indicates if a server is a customer owned device.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerOwnedFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getCustomerOwnedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHasSingleRootVirtualizationBillingItemFlag": { + "get": { + "description": "Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHasSingleRootVirtualizationBillingItemFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHasSingleRootVirtualizationBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getInboundPrivateBandwidthUsage": { + "get": { + "description": "The total private inbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getInboundPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getIsIpmiDisabled": { + "get": { + "description": "Determine if remote management has been disabled due to port speed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getIsIpmiDisabled/", + "operationId": "SoftLayer_Hardware_SecurityModule::getIsIpmiDisabled", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getIsNfsOnly": { + "get": { + "description": "A server that has nfs only drive.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getIsNfsOnly/", + "operationId": "SoftLayer_Hardware_SecurityModule::getIsNfsOnly", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getIsQeInternalServer": { + "get": { + "description": "Determine if hardware object has the QE_INTERNAL_SERVER attribute.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getIsQeInternalServer/", + "operationId": "SoftLayer_Hardware_SecurityModule::getIsQeInternalServer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getIsVirtualPrivateCloudNode": { + "get": { + "description": "Determine if hardware object is a Virtual Private Cloud node.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getIsVirtualPrivateCloudNode/", + "operationId": "SoftLayer_Hardware_SecurityModule::getIsVirtualPrivateCloudNode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getLastOperatingSystemReload": { + "get": { + "description": "The last transaction that a server's operating system was loaded.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getLastOperatingSystemReload/", + "operationId": "SoftLayer_Hardware_SecurityModule::getLastOperatingSystemReload", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getLogicalVolumeStorageGroups": { + "get": { + "description": "Returns a list of logical volumes on the physical machine.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getLogicalVolumeStorageGroups/", + "operationId": "SoftLayer_Hardware_SecurityModule::getLogicalVolumeStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getMetricTrackingObjectId": { + "get": { + "description": "The metric tracking object id for this server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObjectId/", + "operationId": "SoftLayer_Hardware_SecurityModule::getMetricTrackingObjectId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getMonitoringUserNotification": { + "get": { + "description": "The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringUserNotification/", + "operationId": "SoftLayer_Hardware_SecurityModule::getMonitoringUserNotification", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getOpenCancellationTicket": { + "get": { + "description": "An open ticket requesting cancellation of this server, if one exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getOpenCancellationTicket/", + "operationId": "SoftLayer_Hardware_SecurityModule::getOpenCancellationTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getOutboundPrivateBandwidthUsage": { + "get": { + "description": "The total private outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getOutboundPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getOverBandwidthAllocationFlag": { + "get": { + "description": "Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getOverBandwidthAllocationFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getOverBandwidthAllocationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPartitions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPartitions/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPartitions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Server_Partition" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrivateBackendNetworkComponents": { + "get": { + "description": "A collection of backendNetwork components", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBackendNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrivateBackendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrivateIpAddress": { + "get": { + "description": "A server's primary private IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrivateIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getProjectedOverBandwidthAllocationFlag": { + "get": { + "description": "Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedOverBandwidthAllocationFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getProjectedOverBandwidthAllocationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getProjectedPublicBandwidthUsage": { + "get": { + "description": "The projected public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getProjectedPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getReadyNodeFlag": { + "get": { + "description": "Determine if hardware object is vSan Ready Node.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getReadyNodeFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getReadyNodeFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRecentRemoteManagementCommands": { + "get": { + "description": "The last five commands issued to the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRecentRemoteManagementCommands/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRecentRemoteManagementCommands", + "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_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRegionalInternetRegistry": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRegionalInternetRegistry/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRegionalInternetRegistry", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Regional_Internet_Registry" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRemoteManagement": { + "get": { + "description": "A server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagement/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRemoteManagement", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRemoteManagementUsers": { + "get": { + "description": "User(s) who have access to issue commands and/or interact with the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementUsers/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRemoteManagementUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_User" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getSoftwareGuardExtensionEnabled": { + "get": { + "description": "Determine if hardware object has Software Guard Extension (SGX) enabled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareGuardExtensionEnabled/", + "operationId": "SoftLayer_Hardware_SecurityModule::getSoftwareGuardExtensionEnabled", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getStatisticsRemoteManagement": { + "get": { + "description": "A server's remote management card used for statistics.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getStatisticsRemoteManagement/", + "operationId": "SoftLayer_Hardware_SecurityModule::getStatisticsRemoteManagement", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getUefiBootFlag": { + "get": { + "description": "Whether to use UEFI boot instead of BIOS.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getUefiBootFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getUefiBootFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getUsers": { + "get": { + "description": "A list of users that have access to this computing instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getUsers/", + "operationId": "SoftLayer_Hardware_SecurityModule::getUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getVirtualGuests": { + "get": { + "description": "[DEPRECATED] A hardware server's virtual servers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualGuests/", + "operationId": "SoftLayer_Hardware_SecurityModule::getVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAccount": { + "get": { + "description": "The account associated with a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAccount/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getActiveComponents": { + "get": { + "description": "A piece of hardware's active physical components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getActiveComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getActiveComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getActiveNetworkMonitorIncident": { + "get": { + "description": "A piece of hardware's active network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkMonitorIncident/", + "operationId": "SoftLayer_Hardware_SecurityModule::getActiveNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAllPowerComponents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAllPowerComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAllPowerComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Power_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAllowedHost": { + "get": { + "description": "The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedHost/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAllowedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAllowedNetworkStorage": { + "get": { + "description": "The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAllowedNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAllowedNetworkStorageReplicas": { + "get": { + "description": "The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorageReplicas/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAllowedNetworkStorageReplicas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAntivirusSpywareSoftwareComponent": { + "get": { + "description": "Information regarding an antivirus/spyware software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAntivirusSpywareSoftwareComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAntivirusSpywareSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAttributes": { + "get": { + "description": "Information regarding a piece of hardware's specific attributes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAttributes/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getAverageDailyPublicBandwidthUsage": { + "get": { + "description": "The average daily public bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getAverageDailyPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBackendNetworkComponents": { + "get": { + "description": "A piece of hardware's back-end or private network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBackendNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBackendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBackendRouters": { + "get": { + "description": "A hardware's backend or private router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBackendRouters/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBackendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBandwidthAllocation": { + "get": { + "description": "A hardware's allotted bandwidth (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllocation/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBandwidthAllotmentDetail": { + "get": { + "description": "A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllotmentDetail/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBandwidthAllotmentDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBenchmarkCertifications": { + "get": { + "description": "Information regarding a piece of hardware's benchmark certifications.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBenchmarkCertifications/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBenchmarkCertifications", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Benchmark_Certification" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBillingItem": { + "get": { + "description": "Information regarding the billing item for a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItem/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBillingItemFlag": { + "get": { + "description": "A flag indicating that a billing item exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItemFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBlockCancelBecauseDisconnectedFlag": { + "get": { + "description": "Determines whether the hardware is ineligible for cancellation because it is disconnected.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBlockCancelBecauseDisconnectedFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBlockCancelBecauseDisconnectedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBusinessContinuanceInsuranceFlag": { + "get": { + "description": "Status indicating whether or not a piece of hardware has business continuance insurance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getBusinessContinuanceInsuranceFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getBusinessContinuanceInsuranceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getChildrenHardware": { + "get": { + "description": "Child hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getChildrenHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule::getChildrenHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getComponents": { + "get": { + "description": "A piece of hardware's components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getContinuousDataProtectionSoftwareComponent": { + "get": { + "description": "A continuous data protection/server backup software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getContinuousDataProtectionSoftwareComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getContinuousDataProtectionSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getCurrentBillableBandwidthUsage": { + "get": { + "description": "The current billable public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillableBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getCurrentBillableBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDatacenter": { + "get": { + "description": "Information regarding the datacenter in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenter/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDatacenterName": { + "get": { + "description": "The name of the datacenter in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenterName/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDatacenterName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDaysInSparePool": { + "get": { + "description": "Number of day(s) a server have been in spare pool.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDaysInSparePool/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDaysInSparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownlinkHardware": { + "get": { + "description": "All hardware that has uplink network connections to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDownlinkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownlinkNetworkHardware": { + "get": { + "description": "All hardware that has uplink network connections to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkNetworkHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDownlinkNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownlinkServers": { + "get": { + "description": "Information regarding all servers attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkServers/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDownlinkServers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownlinkVirtualGuests": { + "get": { + "description": "Information regarding all virtual guests attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkVirtualGuests/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDownlinkVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownstreamHardwareBindings": { + "get": { + "description": "All hardware downstream from a network device.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamHardwareBindings/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDownstreamHardwareBindings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Uplink_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownstreamNetworkHardware": { + "get": { + "description": "All network hardware downstream from the selected piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDownstreamNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownstreamNetworkHardwareWithIncidents": { + "get": { + "description": "All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardwareWithIncidents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDownstreamNetworkHardwareWithIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownstreamServers": { + "get": { + "description": "Information regarding all servers attached downstream to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamServers/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDownstreamServers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownstreamVirtualGuests": { + "get": { + "description": "Information regarding all virtual guests attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamVirtualGuests/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDownstreamVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDriveControllers": { + "get": { + "description": "The drive controllers contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getDriveControllers/", + "operationId": "SoftLayer_Hardware_SecurityModule::getDriveControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getEvaultNetworkStorage": { + "get": { + "description": "Information regarding a piece of hardware's associated EVault network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getEvaultNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getEvaultNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getFirewallServiceComponent": { + "get": { + "description": "Information regarding a piece of hardware's firewall services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallServiceComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getFirewallServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getFixedConfigurationPreset": { + "get": { + "description": "Defines the fixed components in a fixed configuration bare metal server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getFixedConfigurationPreset/", + "operationId": "SoftLayer_Hardware_SecurityModule::getFixedConfigurationPreset", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getFrontendNetworkComponents": { + "get": { + "description": "A piece of hardware's front-end or public network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getFrontendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getFrontendRouters": { + "get": { + "description": "A hardware's frontend or public router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendRouters/", + "operationId": "SoftLayer_Hardware_SecurityModule::getFrontendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getFutureBillingItem": { + "get": { + "description": "Information regarding the future billing item for a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getFutureBillingItem/", + "operationId": "SoftLayer_Hardware_SecurityModule::getFutureBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getGlobalIdentifier": { + "get": { + "description": "A hardware's universally unique identifier.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getGlobalIdentifier/", + "operationId": "SoftLayer_Hardware_SecurityModule::getGlobalIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHardDrives": { + "get": { + "description": "The hard drives contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHardDrives/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHardDrives", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHardwareChassis": { + "get": { + "description": "The chassis that a piece of hardware is housed in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareChassis/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHardwareChassis", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Chassis" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHardwareFunction": { + "get": { + "description": "A hardware's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunction/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHardwareFunction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Function" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHardwareFunctionDescription": { + "get": { + "description": "A hardware's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunctionDescription/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHardwareFunctionDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHardwareState": { + "get": { + "description": "A hardware's power/transaction state.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareState/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHardwareState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHardwareStatus": { + "get": { + "description": "A hardware's status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareStatus/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHardwareStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHasTrustedPlatformModuleBillingItemFlag": { + "get": { + "description": "Determine in hardware object has TPM enabled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHasTrustedPlatformModuleBillingItemFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHasTrustedPlatformModuleBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHostIpsSoftwareComponent": { + "get": { + "description": "Information regarding a host IPS software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHostIpsSoftwareComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHostIpsSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getHourlyBillingFlag": { + "get": { + "description": "A server's hourly billing status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBillingFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getHourlyBillingFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getInboundBandwidthUsage": { + "get": { + "description": "The sum of all the inbound network traffic data for the last 30 days.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getInboundBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getInboundBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getInboundPublicBandwidthUsage": { + "get": { + "description": "The total public inbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getInboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getIsBillingTermChangeAvailableFlag": { + "get": { + "description": "Whether or not this hardware object is eligible to change to term billing.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getIsBillingTermChangeAvailableFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getIsBillingTermChangeAvailableFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getIsCloudReadyNodeCertified": { + "get": { + "description": "Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getIsCloudReadyNodeCertified/", + "operationId": "SoftLayer_Hardware_SecurityModule::getIsCloudReadyNodeCertified", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getLastTransaction": { + "get": { + "description": "Information regarding the last transaction a server performed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getLastTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule::getLastTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getLatestNetworkMonitorIncident": { + "get": { + "description": "A piece of hardware's latest network monitoring incident.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getLatestNetworkMonitorIncident/", + "operationId": "SoftLayer_Hardware_SecurityModule::getLatestNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getLocation": { + "get": { + "description": "Where a piece of hardware is located within SoftLayer's location hierarchy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getLocation/", + "operationId": "SoftLayer_Hardware_SecurityModule::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getLocationPathString": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getLocationPathString/", + "operationId": "SoftLayer_Hardware_SecurityModule::getLocationPathString", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getLockboxNetworkStorage": { + "get": { + "description": "Information regarding a lockbox account associated with a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getLockboxNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getLockboxNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getManagedResourceFlag": { + "get": { + "description": "A flag indicating that the hardware is a managed resource.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getManagedResourceFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getManagedResourceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getMemory": { + "get": { + "description": "Information regarding a piece of hardware's memory.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getMemory/", + "operationId": "SoftLayer_Hardware_SecurityModule::getMemory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getMemoryCapacity": { + "get": { + "description": "The amount of memory a piece of hardware has, measured in gigabytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getMemoryCapacity/", + "operationId": "SoftLayer_Hardware_SecurityModule::getMemoryCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getMetricTrackingObject": { + "get": { + "description": "A piece of hardware's metric tracking object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObject/", + "operationId": "SoftLayer_Hardware_SecurityModule::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getModules": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getModules/", + "operationId": "SoftLayer_Hardware_SecurityModule::getModules", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getMonitoringRobot": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringRobot/", + "operationId": "SoftLayer_Hardware_SecurityModule::getMonitoringRobot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Monitoring_Robot" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getMonitoringServiceComponent": { + "get": { + "description": "Information regarding a piece of hardware's network monitoring services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getMonitoringServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getMonitoringServiceEligibilityFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceEligibilityFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getMonitoringServiceEligibilityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getMotherboard": { + "get": { + "description": "Information regarding a piece of hardware's motherboard.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getMotherboard/", + "operationId": "SoftLayer_Hardware_SecurityModule::getMotherboard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkCards": { + "get": { + "description": "Information regarding a piece of hardware's network cards.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkCards/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkCards", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkComponents": { + "get": { + "description": "Returns a hardware's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkGatewayMember": { + "get": { + "description": "The gateway member if this device is part of a network gateway.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMember/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkGatewayMember", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkGatewayMemberFlag": { + "get": { + "description": "Whether or not this device is part of a network gateway.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMemberFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkGatewayMemberFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkManagementIpAddress": { + "get": { + "description": "A piece of hardware's network management IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkManagementIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkManagementIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkMonitorAttachedDownHardware": { + "get": { + "description": "All servers with failed monitoring that are attached downstream to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkMonitorAttachedDownHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkMonitorAttachedDownVirtualGuests": { + "get": { + "description": "Virtual guests that are attached downstream to a hardware that have failed monitoring", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownVirtualGuests/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkMonitorAttachedDownVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkMonitorIncidents": { + "get": { + "description": "The status of all of a piece of hardware's network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorIncidents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkMonitorIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkMonitors": { + "get": { + "description": "Information regarding a piece of hardware's network monitors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitors/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkMonitors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkStatus": { + "get": { + "description": "The value of a hardware's network status attribute. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatus/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkStatusAttribute": { + "get": { + "description": "The hardware's related network status attribute. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatusAttribute/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkStatusAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkStorage": { + "get": { + "description": "Information regarding a piece of hardware's associated network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkVlans": { + "get": { + "description": "The network virtual LANs (VLANs) associated with a piece of hardware's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkVlans/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNextBillingCycleBandwidthAllocation": { + "get": { + "description": "A hardware's allotted bandwidth for the next billing cycle (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNextBillingCycleBandwidthAllocation/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNextBillingCycleBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNotesHistory": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNotesHistory/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNotesHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Note" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNvRamCapacity": { + "get": { + "description": "The amount of non-volatile memory a piece of hardware has, measured in gigabytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamCapacity/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNvRamCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNvRamComponentModels": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamComponentModels/", + "operationId": "SoftLayer_Hardware_SecurityModule::getNvRamComponentModels", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getOperatingSystem": { + "get": { + "description": "Information regarding a piece of hardware's operating system.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystem/", + "operationId": "SoftLayer_Hardware_SecurityModule::getOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_OperatingSystem" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getOperatingSystemReferenceCode": { + "get": { + "description": "A hardware's operating system software description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystemReferenceCode/", + "operationId": "SoftLayer_Hardware_SecurityModule::getOperatingSystemReferenceCode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getOutboundBandwidthUsage": { + "get": { + "description": "The sum of all the outbound network traffic data for the last 30 days.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getOutboundBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getOutboundPublicBandwidthUsage": { + "get": { + "description": "The total public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule::getOutboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getParentBay": { + "get": { + "description": "Blade Bay", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getParentBay/", + "operationId": "SoftLayer_Hardware_SecurityModule::getParentBay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Blade" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getParentHardware": { + "get": { + "description": "Parent Hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getParentHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule::getParentHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPointOfPresenceLocation": { + "get": { + "description": "Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPointOfPresenceLocation/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPointOfPresenceLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPowerComponents": { + "get": { + "description": "The power components for a hardware object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPowerComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPowerComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Power_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPowerSupply": { + "get": { + "description": "Information regarding a piece of hardware's power supply.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPowerSupply/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPowerSupply", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrimaryBackendIpAddress": { + "get": { + "description": "The hardware's primary private IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryBackendIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrimaryBackendIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrimaryBackendNetworkComponent": { + "get": { + "description": "Information regarding the hardware's primary back-end network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryBackendNetworkComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrimaryBackendNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrimaryIpAddress": { + "get": { + "description": "The hardware's primary public IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrimaryIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrimaryNetworkComponent": { + "get": { + "description": "Information regarding the hardware's primary public network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryNetworkComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrimaryNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrivateNetworkOnlyFlag": { + "get": { + "description": "Whether the hardware only has access to the private network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkOnlyFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule::getPrivateNetworkOnlyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getProcessorCoreAmount": { + "get": { + "description": "The total number of processor cores, summed from all processors that are attached to a piece of hardware", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorCoreAmount/", + "operationId": "SoftLayer_Hardware_SecurityModule::getProcessorCoreAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getProcessorPhysicalCoreAmount": { + "get": { + "description": "The total number of physical processor cores, summed from all processors that are attached to a piece of hardware", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorPhysicalCoreAmount/", + "operationId": "SoftLayer_Hardware_SecurityModule::getProcessorPhysicalCoreAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getProcessors": { + "get": { + "description": "Information regarding a piece of hardware's processors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getProcessors/", + "operationId": "SoftLayer_Hardware_SecurityModule::getProcessors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRack": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRack/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRaidControllers": { + "get": { + "description": "The RAID controllers contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRaidControllers/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRaidControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRecentEvents": { + "get": { + "description": "Recent events that impact this hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRecentEvents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRecentEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRemoteManagementAccounts": { + "get": { + "description": "User credentials to issue commands and/or interact with the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementAccounts/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRemoteManagementAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_User" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRemoteManagementComponent": { + "get": { + "description": "A hardware's associated remote management component. This is normally IPMI.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRemoteManagementComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getResourceConfigurations": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getResourceConfigurations/", + "operationId": "SoftLayer_Hardware_SecurityModule::getResourceConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Resource_Configuration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getResourceGroupMemberReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupMemberReferences/", + "operationId": "SoftLayer_Hardware_SecurityModule::getResourceGroupMemberReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group_Member" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getResourceGroupRoles": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupRoles/", + "operationId": "SoftLayer_Hardware_SecurityModule::getResourceGroupRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group_Role" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getResourceGroups": { + "get": { + "description": "The resource groups in which this hardware is a member.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroups/", + "operationId": "SoftLayer_Hardware_SecurityModule::getResourceGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getRouters": { + "get": { + "description": "A hardware's routers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getRouters/", + "operationId": "SoftLayer_Hardware_SecurityModule::getRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getSecurityScanRequests": { + "get": { + "description": "Information regarding a piece of hardware's vulnerability scan requests.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getSecurityScanRequests/", + "operationId": "SoftLayer_Hardware_SecurityModule::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_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getServerRoom": { + "get": { + "description": "Information regarding the server room in which the hardware is located.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getServerRoom/", + "operationId": "SoftLayer_Hardware_SecurityModule::getServerRoom", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getServiceProvider": { + "get": { + "description": "Information regarding the piece of hardware's service provider.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getServiceProvider/", + "operationId": "SoftLayer_Hardware_SecurityModule::getServiceProvider", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Service_Provider" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getSoftwareComponents": { + "get": { + "description": "Information regarding a piece of hardware's installed software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getSoftwareComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getSparePoolBillingItem": { + "get": { + "description": "Information regarding the billing item for a spare pool server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getSparePoolBillingItem/", + "operationId": "SoftLayer_Hardware_SecurityModule::getSparePoolBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getSshKeys": { + "get": { + "description": "SSH keys to be installed on the server during provisioning or an OS reload.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getSshKeys/", + "operationId": "SoftLayer_Hardware_SecurityModule::getSshKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getStorageGroups": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getStorageGroups/", + "operationId": "SoftLayer_Hardware_SecurityModule::getStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getStorageNetworkComponents": { + "get": { + "description": "A piece of hardware's private storage network components. [Deprecated]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getStorageNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getStorageNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getTagReferences/", + "operationId": "SoftLayer_Hardware_SecurityModule::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getTopLevelLocation": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getTopLevelLocation/", + "operationId": "SoftLayer_Hardware_SecurityModule::getTopLevelLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getUpgradeRequest": { + "get": { + "description": "An account's associated upgrade request object, if any.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeRequest/", + "operationId": "SoftLayer_Hardware_SecurityModule::getUpgradeRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Upgrade_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getUpgradeableActiveComponents": { + "get": { + "description": "A piece of hardware's active upgradeable physical components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeableActiveComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getUpgradeableActiveComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getUplinkHardware": { + "get": { + "description": "The network device connected to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule::getUplinkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getUplinkNetworkComponents": { + "get": { + "description": "Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule::getUplinkNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getUserData": { + "get": { + "description": "An array containing a single string of custom user data for a hardware order. Max size is 16 kb.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getUserData/", + "operationId": "SoftLayer_Hardware_SecurityModule::getUserData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getVirtualChassis": { + "get": { + "description": "Information regarding the virtual chassis for a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassis/", + "operationId": "SoftLayer_Hardware_SecurityModule::getVirtualChassis", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getVirtualChassisSiblings": { + "get": { + "description": "Information regarding the virtual chassis siblings for a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassisSiblings/", + "operationId": "SoftLayer_Hardware_SecurityModule::getVirtualChassisSiblings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getVirtualHost": { + "get": { + "description": "A piece of hardware's virtual host record.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualHost/", + "operationId": "SoftLayer_Hardware_SecurityModule::getVirtualHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getVirtualLicenses": { + "get": { + "description": "Information regarding a piece of hardware's virtual software licenses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualLicenses/", + "operationId": "SoftLayer_Hardware_SecurityModule::getVirtualLicenses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_VirtualLicense" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getVirtualRack": { + "get": { + "description": "Information regarding the bandwidth allotment to which a piece of hardware belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRack/", + "operationId": "SoftLayer_Hardware_SecurityModule::getVirtualRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getVirtualRackId": { + "get": { + "description": "The name of the bandwidth allotment belonging to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackId/", + "operationId": "SoftLayer_Hardware_SecurityModule::getVirtualRackId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getVirtualRackName": { + "get": { + "description": "The name of the bandwidth allotment belonging to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackName/", + "operationId": "SoftLayer_Hardware_SecurityModule::getVirtualRackName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getVirtualizationPlatform": { + "get": { + "description": "A piece of hardware's virtualization platform software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualizationPlatform/", + "operationId": "SoftLayer_Hardware_SecurityModule::getVirtualizationPlatform", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/createObject": { + "post": { + "description": "\n \ncreateObject() enables the creation of servers on an account. This \nmethod is a simplified alternative to interacting with the ordering system directly. \n\n\nIn order to create a server, a template object must be sent in with a few required \nvalues. \n\n\nWhen this method returns an order will have been placed for a server of the specified configuration. \n\n\nTo determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]], \nchecking the 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 \n
    Hostname for the server.
      \n
    • Required
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
  • domain \n
    Domain for the server.
      \n
    • Required
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
  • processorCoreAmount \n
    The number of logical CPU cores to allocate.
      \n
    • Required
      • \n
    • Type - int
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n
    \n
    • \n
  • memoryCapacity \n
    The amount of memory to allocate in gigabytes.
      \n
    • Required
      • \n
    • Type - int
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n
    \n
    • \n
  • hourlyBillingFlag \n
    Specifies 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
    • \n
  • operatingSystemReferenceCode \n
    An 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
    • \n
  • datacenter.name \n
    Specifies which datacenter the server is to be provisioned in.
      \n
    • Required
      • \n
    • Type - string
      • \n
    • The datacenter property is a [[SoftLayer_Location (type)|location]] structure with the name field set.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"datacenter\": { \n \"name\": \"dal05\" \n } \n} \n
    \n
    • \n
  • networkComponents.maxSpeed \n
    Specifies 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 networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The maxSpeed property 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 { \n \"networkComponents\": [ \n { \n \"maxSpeed\": 1000 \n } \n ] \n} \n
    \n
    • \n
  • networkComponents.redundancyEnabledFlag \n
    Specifies whether or not the server's network components should be in redundancy groups.
      \n
    • Optional
      • \n
    • Type - bool
      • \n
    • Default - false
      • \n
    • Description - The networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the redundancyEnabledFlag property is true the server's network components will be in redundancy groups.
      • \n
    \n { \n \"networkComponents\": [ \n { \n \"redundancyEnabledFlag\": false \n } \n ] \n} \n
    \n
    • \n
  • privateNetworkOnlyFlag \n
    Specifies 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
    • \n
  • primaryNetworkComponent.networkVlan.id \n
    Specifies the network vlan which is to be used for the frontend interface of the server.
      \n
    • Optional
      • \n
    • Type - int
      • \n
    • Description - The primaryNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the frontend network vlan of the server.
      • \n
    \n { \n \"primaryNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 1 \n } \n } \n} \n
    \n
    • \n
  • primaryBackendNetworkComponent.networkVlan.id \n
    Specifies the network vlan which is to be used for the backend interface of the server.
      \n
    • Optional
      • \n
    • Type - int
      • \n
    • Description - The primaryBackendNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the backend network vlan of the server.
      • \n
    \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 fixedConfigurationPreset property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The keyName property must be set to specify preset to use.
      • \n
    • If a fixed configuration preset is used processorCoreAmount, memoryCapacity and hardDrives properties must not be set.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"fixedConfigurationPreset\": { \n \"keyName\": \"SOME_KEY_NAME\" \n } \n} \n
    \n
    • \n
  • userData.value \n
    Arbitrary data to be made available to the server.
      \n
    • Optional
      • \n
    • Type - string
      • \n
    • Description - The userData property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the value property 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 { \n \"userData\": [ \n { \n \"value\": \"someValue\" \n } \n ] \n} \n
    \n
    • \n
  • hardDrives \n
    Hard 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 hardDrives property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures. \n
    • Each hard drive must specify the capacity property.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"hardDrives\": [ \n { \n \"capacity\": 500 \n } \n ] \n} \n
    \n
    • \n
  • sshKeys \n
    SSH 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 sshKeys property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the id property 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 { \n \"sshKeys\": [ \n { \n \"id\": 123 \n } \n ] \n} \n
    \n
    • \n
  • postInstallScriptUri \n
    Specifies the uri location of the script to be downloaded and run after installation is complete.
      \n
    • Optional
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
\n\n\n

REST Example

\ncurl -X POST -d '{ \n \"parameters\":[ \n { \n \"hostname\": \"host1\", \n \"domain\": \"example.com\", \n \"processorCoreAmount\": 2, \n \"memoryCapacity\": 2, \n \"hourlyBillingFlag\": true, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\" \n } \n ] \n}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json \n \nHTTP/1.1 201 Created \nLocation: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject \n\n\n{ \n \"accountId\": 232298, \n \"bareMetalInstanceFlag\": null, \n \"domain\": \"example.com\", \n \"hardwareStatusId\": null, \n \"hostname\": \"host1\", \n \"id\": null, \n \"serviceProviderId\": null, \n \"serviceProviderResourceId\": null, \n \"globalIdentifier\": \"f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5\", \n \"hourlyBillingFlag\": true, \n \"memoryCapacity\": 2, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\", \n \"processorCoreAmount\": 2 \n} \n ", + "summary": "Create a new server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/createObject/", + "operationId": "SoftLayer_Hardware_SecurityModule750::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_SecurityModule750" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Hardware_SecurityModule750 record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getObject/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_SecurityModule750" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/activatePrivatePort": { + "get": { + "description": "Activate a server's private network interface to the maximum available speed. This operation is an alias for [[SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed]] with a $newSpeed of -1 and a $redundancy of \"redundant\" or unspecified (which results in the best available redundancy state). \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending. ", + "summary": "Activate a server's private network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/activatePrivatePort/", + "operationId": "SoftLayer_Hardware_SecurityModule750::activatePrivatePort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/activatePublicPort": { + "get": { + "description": "Activate a server's public network interface to the maximum available speed. This operation is an alias for [[SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed]] with a $newSpeed of -1 and a $redundancy of \"redundant\" or unspecified (which results in the best available redundancy state). \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending. ", + "summary": "Activate a server's public network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/activatePublicPort/", + "operationId": "SoftLayer_Hardware_SecurityModule750::activatePublicPort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/bootToRescueLayer": { + "post": { + "description": "The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server. ", + "summary": "Initiates the Rescue Kernel to bring a server online to troubleshoot system problems.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/bootToRescueLayer/", + "operationId": "SoftLayer_Hardware_SecurityModule750::bootToRescueLayer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/changeRedfishPowerState": { + "post": { + "description": "Changes the power state for the server. The server's power status is changed from its remote management card. ", + "summary": "Changes server's power state using Redfish", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/changeRedfishPowerState/", + "operationId": "SoftLayer_Hardware_SecurityModule750::changeRedfishPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/createFirmwareReflashTransaction": { + "post": { + "description": "You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress. \n\nIn the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware reflash on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareReflashTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule750::createFirmwareReflashTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/createFirmwareUpdateTransaction": { + "post": { + "description": "You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware updates on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareUpdateTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule750::createFirmwareUpdateTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/createHyperThreadingUpdateTransaction": { + "post": { + "description": "You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress. \n\nIn the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs BIOS update on the server to change the hyper-threading configuration.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/createHyperThreadingUpdateTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule750::createHyperThreadingUpdateTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/createPostSoftwareInstallTransaction": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/createPostSoftwareInstallTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule750::createPostSoftwareInstallTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/editObject": { + "post": { + "description": "Edit a server's properties ", + "summary": "Edit a server's properties", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/editObject/", + "operationId": "SoftLayer_Hardware_SecurityModule750::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBackendBandwidthUsage": { + "post": { + "description": "Use this method to return an array of private bandwidth utilization records between a given date range. \n\nThis method represents the NEW version of getFrontendBandwidthUse ", + "summary": "Retrieves public bandwidth usage records.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBackendBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthForDateRange/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBandwidthForDateRange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBandwidthImage": { + "post": { + "description": "Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image. ", + "summary": "Retrieve a bandwidth image and textual description of that image for this server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthImage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBandwidthImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBootModeOptions": { + "get": { + "description": "Retrieve the valid boot modes for this server ", + "summary": "Retrieve the valid boot modes for this server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBootModeOptions/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBootModeOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getCurrentBenchmarkCertificationResultFile": { + "get": { + "description": "Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception. ", + "summary": "Get the file for the current benchmark certification result, if it exists.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBenchmarkCertificationResultFile/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getCurrentBenchmarkCertificationResultFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getFirewallProtectableSubnets": { + "get": { + "description": "Get the subnets associated with this server that are protectable by a network component firewall. ", + "summary": "Get the subnets associated with this server that are protectable by a network component firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallProtectableSubnets/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getFirewallProtectableSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getFrontendBandwidthUsage": { + "post": { + "description": "Use this method to return an array of public bandwidth utilization records between a given date range. \n\nThis method represents the NEW version of getFrontendBandwidthUse ", + "summary": "Retrieves public bandwidth usage records.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getFrontendBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/getHardwareByIpAddress": { + "post": { + "description": "Retrieve a server by searching for the primary IP address. ", + "summary": "Retrieve a SoftLayer_Hardware_Server object by IP address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareByIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHardwareByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Server" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getItemPricesFromSoftwareDescriptions": { + "post": { + "description": "Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description", + "summary": "Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getItemPricesFromSoftwareDescriptions/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getItemPricesFromSoftwareDescriptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getManagementNetworkComponent": { + "get": { + "description": "Retrieve the remote management network component attached with this server. ", + "summary": "Retrieve a server's management network component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getManagementNetworkComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getManagementNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkComponentFirewallProtectableIpAddresses": { + "get": { + "description": "Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this server. Please use getFirewallProtectableSubnets to get all protectable subnets. ", + "summary": "Get the IP addresses associated with this server that are protectable by a network component firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponentFirewallProtectableIpAddresses/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkComponentFirewallProtectableIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPMInfo": { + "get": { + "description": "Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires. ", + "summary": "Retrieve a server's hardware state via its internal sensors.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPMInfo/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPMInfo", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_PmInfo" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrimaryDriveSize": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryDriveSize/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrimaryDriveSize", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrivateBandwidthDataSummary": { + "get": { + "description": "Retrieve a brief summary of a server's private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period. ", + "summary": "Retrieve a server's private bandwidth usage summary", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthDataSummary/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrivateBandwidthDataSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Bandwidth_Data_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrivateBandwidthGraphImage": { + "post": { + "description": "Retrieve a graph of a server's private network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image ", + "summary": "Retrieve a graph of a server's private network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthGraphImage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrivateBandwidthGraphImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrivateNetworkComponent": { + "get": { + "description": "Retrieve the private network component attached with this server. ", + "summary": "Retrieve a server's private network component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrivateNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrivateVlan": { + "get": { + "description": "Retrieve the backend VLAN for the primary IP address of the server ", + "summary": "Retrieve the backend VLAN for the primary IP address of the server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlan/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrivateVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress": { + "post": { + "description": "\n*** DEPRECATED ***\nRetrieve a backend network VLAN by searching for an IP address ", + "summary": "Retrieve a backend network VLAN by searching for an IP address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrivateVlanByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getProvisionDate": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getProvisionDate/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getProvisionDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPublicBandwidthDataSummary": { + "get": { + "description": "Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period. ", + "summary": "Retrieve a server's public bandwidth usage summary", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthDataSummary/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPublicBandwidthDataSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Bandwidth_Data_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPublicBandwidthGraphImage": { + "post": { + "description": "Retrieve a graph of a server's public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY. ", + "summary": "Retrieve a graph of a server's public network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthGraphImage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPublicBandwidthGraphImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPublicBandwidthTotal": { + "post": { + "description": "Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware. ", + "summary": "Retrieve total number of public bytes used by a server over time period specified.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthTotal/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPublicBandwidthTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPublicNetworkComponent": { + "get": { + "description": "Retrieve a SoftLayer server's public network component. Some servers are only connected to the private network and may not have a public network component. In that case getPublicNetworkComponent returns a null object. ", + "summary": "Retrieve a server's public network component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicNetworkComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPublicNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPublicVlan": { + "get": { + "description": "Retrieve the frontend VLAN for the primary IP address of the server ", + "summary": "Retrieve the frontend VLAN for the primary IP address of the server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlan/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPublicVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/getPublicVlanByHostname": { + "post": { + "description": "Retrieve the frontend network Vlan by searching the hostname of a server ", + "summary": "Retrieve the frontend VLAN by a server's hostname.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlanByHostname/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPublicVlanByHostname", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRedfishPowerState": { + "get": { + "description": "Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'. ", + "summary": "Retrieves server's power state using Redfish", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRedfishPowerState/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRedfishPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getReverseDomainRecords": { + "get": { + "description": "Retrieve the reverse domain records associated with this server. ", + "summary": "Retrieve the reverse domain records associated with a server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getReverseDomainRecords/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getReverseDomainRecords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Dns_Domain" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getSensorData": { + "get": { + "description": "Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires. ", + "summary": "Retrieve a server's hardware state via its internal sensors.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorData/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getSensorData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_SensorReading" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getSensorDataWithGraphs": { + "get": { + "description": "Retrieves the raw data returned from the server's remote management card. For more details of what is returned please refer to the getSensorData method. Along with the raw data, graphs for the cpu and system temperatures and fan speeds are also returned. ", + "summary": "Retrieve server's temperature and fan speed graphs as well the sensor raw data.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorDataWithGraphs/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getSensorDataWithGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getServerDetails": { + "get": { + "description": "Retrieve a server's hardware components, software, and network components. getServerDetails is an aggregation function that combines the results of [[SoftLayer_Hardware_Server::getComponents]], [[SoftLayer_Hardware_Server::getSoftware]], and [[SoftLayer_Hardware_Server::getNetworkComponents]] in a single container. ", + "summary": "Retrieve a server's hardware components, software, and network components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getServerDetails/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getServerDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Details" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getServerFanSpeedGraphs": { + "get": { + "description": "Retrieve the server's fan speeds and displays them using tachometer graphs. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it. ", + "summary": "Retrieve server's fan speed graphs.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getServerFanSpeedGraphs/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getServerFanSpeedGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getServerPowerState": { + "get": { + "description": "Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'. ", + "summary": "Retrieves server's power state", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getServerPowerState/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getServerPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getServerTemperatureGraphs": { + "get": { + "description": "Retrieve the server's temperature and displays them using thermometer graphs. Temperatures retrieved are CPU(s) and system temperatures. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it. ", + "summary": "Retrieve server's temperature graphs", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getServerTemperatureGraphs/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getServerTemperatureGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getValidBlockDeviceTemplateGroups": { + "post": { + "description": "This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images. ", + "summary": "Return a list of valid block device template groups based on this host", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getValidBlockDeviceTemplateGroups/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getValidBlockDeviceTemplateGroups", + "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_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getWindowsUpdateAvailableUpdates": { + "get": { + "description": "Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default. ", + "summary": "Retrieve a list of Windows updates available to a server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateAvailableUpdates/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getWindowsUpdateAvailableUpdates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getWindowsUpdateInstalledUpdates": { + "get": { + "description": "Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default. ", + "summary": "Retrieve a list of Windows updates installed on a server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateInstalledUpdates/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getWindowsUpdateInstalledUpdates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getWindowsUpdateStatus": { + "get": { + "description": "This method returns an update status record for this server. That record will specify if the server is missing updates, or has updates that must be reinstalled or require a reboot to go into affect. ", + "summary": "Retrieve a server's Windows update synchronization status", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateStatus/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getWindowsUpdateStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/initiateIderaBareMetalRestore": { + "get": { + "description": "Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup. ", + "summary": "Initiate an Idera bare metal restore for the server tied to an Idera Server Backup", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/initiateIderaBareMetalRestore/", + "operationId": "SoftLayer_Hardware_SecurityModule750::initiateIderaBareMetalRestore", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/initiateR1SoftBareMetalRestore": { + "get": { + "description": "R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup. ", + "summary": "Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/initiateR1SoftBareMetalRestore/", + "operationId": "SoftLayer_Hardware_SecurityModule750::initiateR1SoftBareMetalRestore", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/isBackendPingable": { + "get": { + "description": "Issues a ping command and returns the success (true) or failure (false) of the ping command. ", + "summary": "Verifies if a server's backend ip address is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/isBackendPingable/", + "operationId": "SoftLayer_Hardware_SecurityModule750::isBackendPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/isPingable": { + "get": { + "description": "Issues a ping command and returns the success (true) or failure (false) of the ping command. ", + "summary": "Verifies if server is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/isPingable/", + "operationId": "SoftLayer_Hardware_SecurityModule750::isPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/isWindowsServer": { + "get": { + "description": "Determine if the server runs any version of the Microsoft Windows operating systems. Return ''true'' if it does and ''false if otherwise. ", + "summary": "Determine if a server runs the Microsoft Windows operating system.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/isWindowsServer/", + "operationId": "SoftLayer_Hardware_SecurityModule750::isWindowsServer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/massFirmwareReflash": { + "post": { + "description": "You can launch firmware reflashes by selecting from your server list. It will bring your server offline for approximately 60 minutes while the reflashes are in progress. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be contact you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware reflashes on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareReflash/", + "operationId": "SoftLayer_Hardware_SecurityModule750::massFirmwareReflash", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/massFirmwareUpdate": { + "post": { + "description": "You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware updates on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareUpdate/", + "operationId": "SoftLayer_Hardware_SecurityModule750::massFirmwareUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/massHyperThreadingUpdate": { + "post": { + "description": "You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the updates are in progress. \n\nIn the event of a hardware failure during this update our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be in contact with you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware reflashes on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/massHyperThreadingUpdate/", + "operationId": "SoftLayer_Hardware_SecurityModule750::massHyperThreadingUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/massReloadOperatingSystem": { + "post": { + "description": "Reloads current or customer specified operating system configuration. \n\nThis service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server. \n\nAs a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record. \n\nThe reload will take AT MINIMUM 66 minutes. ", + "summary": "Reloads operating system configuration on a set of hardware Ids.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/massReloadOperatingSystem/", + "operationId": "SoftLayer_Hardware_SecurityModule750::massReloadOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/massSparePool": { + "post": { + "description": "The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program. ", + "summary": "Allows multiple servers to be added to or removed from the spare pool.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/massSparePool/", + "operationId": "SoftLayer_Hardware_SecurityModule750::massSparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/ping": { + "get": { + "description": "Issues a ping command to the server and returns the ping response. ", + "summary": "Issues ping command.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/ping/", + "operationId": "SoftLayer_Hardware_SecurityModule750::ping", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/populateServerRam": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/populateServerRam/", + "operationId": "SoftLayer_Hardware_SecurityModule750::populateServerRam", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/powerCycle": { + "get": { + "description": "Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Issues power cycle to server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/powerCycle/", + "operationId": "SoftLayer_Hardware_SecurityModule750::powerCycle", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/powerOff": { + "get": { + "description": "This method will power off the server via the server's remote management card. ", + "summary": "Power off server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/powerOff/", + "operationId": "SoftLayer_Hardware_SecurityModule750::powerOff", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/powerOn": { + "get": { + "description": "Power on server via its remote management card. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Power on server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/powerOn/", + "operationId": "SoftLayer_Hardware_SecurityModule750::powerOn", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/rebootDefault": { + "get": { + "description": "Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card. If the reset (soft reboot) attempt is unsuccessful, a power cycle command will be issued via the powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Reboot the server via the default method.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/rebootDefault/", + "operationId": "SoftLayer_Hardware_SecurityModule750::rebootDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/rebootHard": { + "get": { + "description": "Reboot the server by issuing a cycle command to the server's remote management card. This is equivalent to pressing the 'Reset' button on the server. This command is issued immediately and will not wait for processes to shutdown. After this command is issued, the server may take a few moments to boot up as server may run system disks checks. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Reboot the server via \"hard\" reboot.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/rebootHard/", + "operationId": "SoftLayer_Hardware_SecurityModule750::rebootHard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/rebootSoft": { + "get": { + "description": "Reboot the server by issuing a reset command to the server's remote management card. This is a graceful reboot. The servers will allow all process to shutdown gracefully before rebooting. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Reboot the server via gracefully (soft reboot).", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/rebootSoft/", + "operationId": "SoftLayer_Hardware_SecurityModule750::rebootSoft", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/reloadCurrentOperatingSystemConfiguration": { + "post": { + "description": "Reloads current operating system configuration. \n\nThis service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server. \n\nAs a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record. \n\nThe reload will take AT MINIMUM 66 minutes. ", + "summary": "Reloads current operating system configuration.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/reloadCurrentOperatingSystemConfiguration/", + "operationId": "SoftLayer_Hardware_SecurityModule750::reloadCurrentOperatingSystemConfiguration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/reloadOperatingSystem": { + "post": { + "description": "Reloads current or customer specified operating system configuration. \n\nThis service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server. \n\nAs a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record. \n\nThe reload will take AT MINIMUM 66 minutes. ", + "summary": "Reloads operating system configuration.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/reloadOperatingSystem/", + "operationId": "SoftLayer_Hardware_SecurityModule750::reloadOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/runPassmarkCertificationBenchmark": { + "get": { + "description": "You can launch a new Passmark hardware test by selecting from your server list. It will bring your server offline for approximately 20 minutes while the testing is in progress, and will publish a certificate with the results to your hardware details page. \n\nWhile the hard drives are tested for the initial deployment, the Passmark Certificate utility will not test the hard drives on your live server. This is to ensure that no data is overwritten. If you would like to test the server's hard drives, you can have the full Passmark suite installed to your server free of charge through a new Support ticket. \n\nWhile the test itself does not overwrite any data on the server, it is recommended that you make full off-server backups of all data prior to launching the test. The Passmark hardware test is designed to force any latent hardware issues to the surface, so hardware failure is possible. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs a hardware stress test on the server to obtain a Passmark Certification.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/runPassmarkCertificationBenchmark/", + "operationId": "SoftLayer_Hardware_SecurityModule750::runPassmarkCertificationBenchmark", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/setOperatingSystemPassword": { + "post": { + "description": "Changes the password that we have stored in our database for a servers' Operating System", + "summary": "Changes the password stored in our system for a servers' Operating System", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/setOperatingSystemPassword/", + "operationId": "SoftLayer_Hardware_SecurityModule750::setOperatingSystemPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/setPrivateNetworkInterfaceSpeed": { + "post": { + "description": "Set the private network interface speed and redundancy configuration. \n\nPossible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available. \n\nIf specified, possible $redundancy values are either \"redundant\" or \"degraded\". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. \"redundant\" indicates all available interfaces should be active. \"degraded\" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending. \n\n

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\".
After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1. ", + "summary": "Set the speed and redundancy configuration of a server's private network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/setPrivateNetworkInterfaceSpeed/", + "operationId": "SoftLayer_Hardware_SecurityModule750::setPrivateNetworkInterfaceSpeed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/setPublicNetworkInterfaceSpeed": { + "post": { + "description": "Set the public network interface speed and redundancy configuration. \n\nPossible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available. \n\nIf specified, possible $redundancy values are either \"redundant\" or \"degraded\". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. \"redundant\" indicates all available interfaces should be active. \"degraded\" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending. \n\n

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\".
After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1. ", + "summary": "Set the speed and redundancy configuration of a server's public network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/setPublicNetworkInterfaceSpeed/", + "operationId": "SoftLayer_Hardware_SecurityModule750::setPublicNetworkInterfaceSpeed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/setUserMetadata": { + "post": { + "description": "Sets the data that will be written to the configuration drive. ", + "summary": "Sets the server's user metadata value.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/setUserMetadata/", + "operationId": "SoftLayer_Hardware_SecurityModule750::setUserMetadata", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/shutdownPrivatePort": { + "get": { + "description": "Disconnect a server's private network interface. This operation is an alias for calling [[SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed]] with a $newSpeed of 0 and unspecified $redundancy. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending. ", + "summary": "Disconnect a server's private network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPrivatePort/", + "operationId": "SoftLayer_Hardware_SecurityModule750::shutdownPrivatePort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/shutdownPublicPort": { + "get": { + "description": "Disconnect a server's public network interface. This operation is an alias for [[SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed]] with a $newSpeed of 0 and unspecified $redundancy. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending. ", + "summary": "Disconnect a server's public network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPublicPort/", + "operationId": "SoftLayer_Hardware_SecurityModule750::shutdownPublicPort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/sparePool": { + "post": { + "description": "The ability to place bare metal servers in a state where they are powered down, and ports closed yet still allocated to the customer as a part of the Spare Pool program. ", + "summary": "Allows servers to be added to or removed from the spare pool.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/sparePool/", + "operationId": "SoftLayer_Hardware_SecurityModule750::sparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/testRaidAlertService": { + "get": { + "description": "Test the RAID Alert service by sending the service a request to store a test email for this server. The server must have an account ID and MAC address. A RAID controller must also be installed. ", + "summary": "Tests the RAID Alert service.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/testRaidAlertService/", + "operationId": "SoftLayer_Hardware_SecurityModule750::testRaidAlertService", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/toggleManagementInterface": { + "post": { + "description": "Attempt to toggle the IPMI interface. If there is an active transaction on the server, it will throw an exception. This method creates a job to toggle the interface. It is not instant. ", + "summary": "Toggle the IPMI interface on and off.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/toggleManagementInterface/", + "operationId": "SoftLayer_Hardware_SecurityModule750::toggleManagementInterface", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/updateIpmiPassword": { + "post": { + "description": "This method will update the root IPMI password on this SoftLayer_Hardware. ", + "summary": "Update the root IPMI user password ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/updateIpmiPassword/", + "operationId": "SoftLayer_Hardware_SecurityModule750::updateIpmiPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/validatePartitionsForOperatingSystem": { + "post": { + "description": "Validates a collection of partitions for an operating system", + "summary": "Validates a collection of partitions for an operating system", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/validatePartitionsForOperatingSystem/", + "operationId": "SoftLayer_Hardware_SecurityModule750::validatePartitionsForOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/validateSecurityLevel": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/validateSecurityLevel/", + "operationId": "SoftLayer_Hardware_SecurityModule750::validateSecurityLevel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/allowAccessToNetworkStorage": { + "post": { + "description": "This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control. ", + "summary": "Allow access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::allowAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/allowAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Allow access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorageList/", + "operationId": "SoftLayer_Hardware_SecurityModule750::allowAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/captureImage": { + "post": { + "description": "Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image. ", + "summary": "Captures an Image of the hard disk on the physical machine.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/captureImage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::captureImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/deleteObject": { + "get": { + "description": "\nThis method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns. ", + "summary": "Delete a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/deleteObject/", + "operationId": "SoftLayer_Hardware_SecurityModule750::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/deleteSoftwareComponentPasswords": { + "post": { + "description": "Delete software component passwords. ", + "summary": "Delete software component passwords.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/deleteSoftwareComponentPasswords/", + "operationId": "SoftLayer_Hardware_SecurityModule750::deleteSoftwareComponentPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/deleteTag": { + "post": { + "description": "Delete an existing tag. If there are any references on the tag, an exception will be thrown. ", + "summary": "Delete a tag", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/deleteTag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::deleteTag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/editSoftwareComponentPasswords": { + "post": { + "description": "Edit the properties of a software component password such as the username, password, and notes. ", + "summary": "Edit the properties of software component passwords.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/editSoftwareComponentPasswords/", + "operationId": "SoftLayer_Hardware_SecurityModule750::editSoftwareComponentPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/executeRemoteScript": { + "post": { + "description": "Download and run remote script from uri on the hardware.", + "summary": "Download and run remote script from uri on the hardware. Requires https for script to be executed after download. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/executeRemoteScript/", + "operationId": "SoftLayer_Hardware_SecurityModule750::executeRemoteScript", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/findByIpAddress": { + "post": { + "description": "The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned. ", + "summary": "Find hardware by its primary public or private IP (ipv4) address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/findByIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule750::findByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/generateOrderTemplate": { + "post": { + "description": "\nObtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]]. \n\n\nThis is primarily useful when there is a necessity to confirm the price which will be charged for an order. \n\n\nSee [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter. ", + "summary": "Obtain an order container for a given template object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/generateOrderTemplate/", + "operationId": "SoftLayer_Hardware_SecurityModule750::generateOrderTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAttachedNetworkStorages": { + "post": { + "description": "This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAttachedNetworkStorages/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAttachedNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAvailableBillingTermChangePrices": { + "get": { + "description": "Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers. ", + "summary": "Retrieves a list of available term prices available to this of hardware. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableBillingTermChangePrices/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAvailableBillingTermChangePrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAvailableNetworkStorages": { + "post": { + "description": "This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableNetworkStorages/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAvailableNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBackendIncomingBandwidth": { + "post": { + "description": "The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes. ", + "summary": "Retrieve the amount of incoming private network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendIncomingBandwidth/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBackendIncomingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBackendOutgoingBandwidth": { + "post": { + "description": "The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes. ", + "summary": "Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendOutgoingBandwidth/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBackendOutgoingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getComponentDetailsXML": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getComponentDetailsXML/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getComponentDetailsXML", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/getCreateObjectOptions": { + "get": { + "description": "\nThere are many options that may be provided while ordering a server, this method can be used to determine what these options are. \n\n\nDetailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]]. ", + "summary": "Determine options available when creating a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getCreateObjectOptions/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getCreateObjectOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Configuration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getCurrentBillingDetail": { + "get": { + "description": "Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage. ", + "summary": "<< EOT", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingDetail/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getCurrentBillingDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getCurrentBillingTotal": { + "get": { + "description": "Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware. ", + "summary": "Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingTotal/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getCurrentBillingTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDailyAverage": { + "post": { + "description": "The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day. ", + "summary": "calculate the average daily network traffic used by a server in gigabytes.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDailyAverage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDailyAverage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getFrontendIncomingBandwidth": { + "post": { + "description": "The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB). ", + "summary": "Retrieve the amount of incoming public network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendIncomingBandwidth/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getFrontendIncomingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getFrontendOutgoingBandwidth": { + "post": { + "description": "The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB). ", + "summary": "Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendOutgoingBandwidth/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getFrontendOutgoingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHourlyBandwidth": { + "post": { + "description": "The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of \n\n'02/01/2008 0:00' \n\nresults in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time). \n\nFor data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware. ", + "summary": "Retrieves bandwidth hourly over a 24-hour period for the specified hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBandwidth/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHourlyBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrivateBandwidthData": { + "post": { + "description": "Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. ", + "summary": "Retrieve a graph of a server's private network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthData/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrivateBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPublicBandwidthData": { + "post": { + "description": "Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. ", + "summary": "Retrieve a graph of a server's public network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthData/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPublicBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getTransactionHistory": { + "get": { + "description": "\nThis method will query transaction history for a piece of hardware. ", + "summary": "Get transaction history for a piece of hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getTransactionHistory/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getTransactionHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getUpgradeItemPrices": { + "get": { + "description": "Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs. ", + "summary": "Retrieve a list of upgradeable items available to a piece of hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeItemPrices/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getUpgradeItemPrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/importVirtualHost": { + "get": { + "description": "The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.", + "summary": "attempt to import the host record for the virtualization platform running on a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/importVirtualHost/", + "operationId": "SoftLayer_Hardware_SecurityModule750::importVirtualHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/refreshDeviceStatus": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/refreshDeviceStatus/", + "operationId": "SoftLayer_Hardware_SecurityModule750::refreshDeviceStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/removeAccessToNetworkStorage": { + "post": { + "description": "This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control. ", + "summary": "Remove access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::removeAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/removeAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Remove access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorageList/", + "operationId": "SoftLayer_Hardware_SecurityModule750::removeAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/removeTags": { + "post": { + "description": null, + "summary": "Remove a tag reference", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/removeTags/", + "operationId": "SoftLayer_Hardware_SecurityModule750::removeTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/setTags": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/setTags/", + "operationId": "SoftLayer_Hardware_SecurityModule750::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getActiveNetworkFirewallBillingItem": { + "get": { + "description": "The billing item for a server's attached network firewall.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkFirewallBillingItem/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getActiveNetworkFirewallBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getActiveTickets": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTickets/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getActiveTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getActiveTransaction": { + "get": { + "description": "Transaction currently running for server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getActiveTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getActiveTransactions": { + "get": { + "description": "Any active transaction(s) that are currently running for the server (example: os reload).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransactions/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getActiveTransactions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAvailableMonitoring": { + "get": { + "description": "An object that stores the maximum level for the monitoring query types and response types.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableMonitoring/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAvailableMonitoring", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAverageDailyBandwidthUsage": { + "get": { + "description": "The average daily total bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAverageDailyBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAverageDailyPrivateBandwidthUsage": { + "get": { + "description": "The average daily private bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAverageDailyPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBillingCycleBandwidthUsage": { + "get": { + "description": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCycleBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBillingCycleBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBillingCyclePrivateBandwidthUsage": { + "get": { + "description": "The raw private bandwidth usage data for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBillingCyclePrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBillingCyclePublicBandwidthUsage": { + "get": { + "description": "The raw public bandwidth usage data for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBillingCyclePublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBiosPasswordNullFlag": { + "get": { + "description": "Determine if BIOS password should be left as null.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBiosPasswordNullFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBiosPasswordNullFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getCaptureEnabledFlag": { + "get": { + "description": "Determine if the server is able to be image captured. If unable to image capture a reason will be provided.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getCaptureEnabledFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getCaptureEnabledFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_CaptureEnabled" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getContainsSolidStateDrivesFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getContainsSolidStateDrivesFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getContainsSolidStateDrivesFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getControlPanel": { + "get": { + "description": "A server's control panel.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getControlPanel/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getControlPanel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_ControlPanel" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getCost": { + "get": { + "description": "The total cost of a server, measured in US Dollars ($USD).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getCost/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getCost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getCurrentBandwidthSummary": { + "get": { + "description": "An object that provides commonly used bandwidth summary components for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBandwidthSummary/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getCurrentBandwidthSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getCustomerInstalledOperatingSystemFlag": { + "get": { + "description": "Indicates if a server has a Customer Installed OS", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerInstalledOperatingSystemFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getCustomerInstalledOperatingSystemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getCustomerOwnedFlag": { + "get": { + "description": "Indicates if a server is a customer owned device.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerOwnedFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getCustomerOwnedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHasSingleRootVirtualizationBillingItemFlag": { + "get": { + "description": "Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHasSingleRootVirtualizationBillingItemFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHasSingleRootVirtualizationBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getInboundPrivateBandwidthUsage": { + "get": { + "description": "The total private inbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getInboundPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getIsIpmiDisabled": { + "get": { + "description": "Determine if remote management has been disabled due to port speed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getIsIpmiDisabled/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getIsIpmiDisabled", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getIsNfsOnly": { + "get": { + "description": "A server that has nfs only drive.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getIsNfsOnly/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getIsNfsOnly", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getIsQeInternalServer": { + "get": { + "description": "Determine if hardware object has the QE_INTERNAL_SERVER attribute.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getIsQeInternalServer/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getIsQeInternalServer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getIsVirtualPrivateCloudNode": { + "get": { + "description": "Determine if hardware object is a Virtual Private Cloud node.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getIsVirtualPrivateCloudNode/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getIsVirtualPrivateCloudNode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getLastOperatingSystemReload": { + "get": { + "description": "The last transaction that a server's operating system was loaded.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getLastOperatingSystemReload/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getLastOperatingSystemReload", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getLogicalVolumeStorageGroups": { + "get": { + "description": "Returns a list of logical volumes on the physical machine.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getLogicalVolumeStorageGroups/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getLogicalVolumeStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getMetricTrackingObjectId": { + "get": { + "description": "The metric tracking object id for this server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObjectId/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getMetricTrackingObjectId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getMonitoringUserNotification": { + "get": { + "description": "The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringUserNotification/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getMonitoringUserNotification", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getOpenCancellationTicket": { + "get": { + "description": "An open ticket requesting cancellation of this server, if one exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getOpenCancellationTicket/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getOpenCancellationTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getOutboundPrivateBandwidthUsage": { + "get": { + "description": "The total private outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getOutboundPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getOverBandwidthAllocationFlag": { + "get": { + "description": "Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getOverBandwidthAllocationFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getOverBandwidthAllocationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPartitions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPartitions/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPartitions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Server_Partition" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrivateBackendNetworkComponents": { + "get": { + "description": "A collection of backendNetwork components", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBackendNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrivateBackendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrivateIpAddress": { + "get": { + "description": "A server's primary private IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrivateIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getProjectedOverBandwidthAllocationFlag": { + "get": { + "description": "Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedOverBandwidthAllocationFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getProjectedOverBandwidthAllocationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getProjectedPublicBandwidthUsage": { + "get": { + "description": "The projected public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getProjectedPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getReadyNodeFlag": { + "get": { + "description": "Determine if hardware object is vSan Ready Node.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getReadyNodeFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getReadyNodeFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRecentRemoteManagementCommands": { + "get": { + "description": "The last five commands issued to the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentRemoteManagementCommands/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRecentRemoteManagementCommands", + "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_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRegionalInternetRegistry": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRegionalInternetRegistry/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRegionalInternetRegistry", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Regional_Internet_Registry" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRemoteManagement": { + "get": { + "description": "A server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagement/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRemoteManagement", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRemoteManagementUsers": { + "get": { + "description": "User(s) who have access to issue commands and/or interact with the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementUsers/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRemoteManagementUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_User" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getSoftwareGuardExtensionEnabled": { + "get": { + "description": "Determine if hardware object has Software Guard Extension (SGX) enabled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareGuardExtensionEnabled/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getSoftwareGuardExtensionEnabled", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getStatisticsRemoteManagement": { + "get": { + "description": "A server's remote management card used for statistics.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getStatisticsRemoteManagement/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getStatisticsRemoteManagement", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getUefiBootFlag": { + "get": { + "description": "Whether to use UEFI boot instead of BIOS.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getUefiBootFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getUefiBootFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getUsers": { + "get": { + "description": "A list of users that have access to this computing instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getUsers/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getVirtualGuests": { + "get": { + "description": "[DEPRECATED] A hardware server's virtual servers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualGuests/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAccount": { + "get": { + "description": "The account associated with a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAccount/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getActiveComponents": { + "get": { + "description": "A piece of hardware's active physical components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getActiveComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getActiveNetworkMonitorIncident": { + "get": { + "description": "A piece of hardware's active network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkMonitorIncident/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getActiveNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAllPowerComponents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAllPowerComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAllPowerComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Power_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAllowedHost": { + "get": { + "description": "The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedHost/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAllowedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAllowedNetworkStorage": { + "get": { + "description": "The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAllowedNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAllowedNetworkStorageReplicas": { + "get": { + "description": "The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorageReplicas/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAllowedNetworkStorageReplicas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAntivirusSpywareSoftwareComponent": { + "get": { + "description": "Information regarding an antivirus/spyware software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAntivirusSpywareSoftwareComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAntivirusSpywareSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAttributes": { + "get": { + "description": "Information regarding a piece of hardware's specific attributes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAttributes/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getAverageDailyPublicBandwidthUsage": { + "get": { + "description": "The average daily public bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getAverageDailyPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBackendNetworkComponents": { + "get": { + "description": "A piece of hardware's back-end or private network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBackendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBackendRouters": { + "get": { + "description": "A hardware's backend or private router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendRouters/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBackendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBandwidthAllocation": { + "get": { + "description": "A hardware's allotted bandwidth (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllocation/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBandwidthAllotmentDetail": { + "get": { + "description": "A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllotmentDetail/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBandwidthAllotmentDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBenchmarkCertifications": { + "get": { + "description": "Information regarding a piece of hardware's benchmark certifications.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBenchmarkCertifications/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBenchmarkCertifications", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Benchmark_Certification" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBillingItem": { + "get": { + "description": "Information regarding the billing item for a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItem/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBillingItemFlag": { + "get": { + "description": "A flag indicating that a billing item exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItemFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBlockCancelBecauseDisconnectedFlag": { + "get": { + "description": "Determines whether the hardware is ineligible for cancellation because it is disconnected.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBlockCancelBecauseDisconnectedFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBlockCancelBecauseDisconnectedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBusinessContinuanceInsuranceFlag": { + "get": { + "description": "Status indicating whether or not a piece of hardware has business continuance insurance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getBusinessContinuanceInsuranceFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getBusinessContinuanceInsuranceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getChildrenHardware": { + "get": { + "description": "Child hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getChildrenHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getChildrenHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getComponents": { + "get": { + "description": "A piece of hardware's components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getContinuousDataProtectionSoftwareComponent": { + "get": { + "description": "A continuous data protection/server backup software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getContinuousDataProtectionSoftwareComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getContinuousDataProtectionSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getCurrentBillableBandwidthUsage": { + "get": { + "description": "The current billable public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillableBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getCurrentBillableBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDatacenter": { + "get": { + "description": "Information regarding the datacenter in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenter/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDatacenterName": { + "get": { + "description": "The name of the datacenter in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenterName/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDatacenterName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDaysInSparePool": { + "get": { + "description": "Number of day(s) a server have been in spare pool.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDaysInSparePool/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDaysInSparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownlinkHardware": { + "get": { + "description": "All hardware that has uplink network connections to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDownlinkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownlinkNetworkHardware": { + "get": { + "description": "All hardware that has uplink network connections to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkNetworkHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDownlinkNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownlinkServers": { + "get": { + "description": "Information regarding all servers attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkServers/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDownlinkServers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownlinkVirtualGuests": { + "get": { + "description": "Information regarding all virtual guests attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkVirtualGuests/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDownlinkVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownstreamHardwareBindings": { + "get": { + "description": "All hardware downstream from a network device.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamHardwareBindings/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDownstreamHardwareBindings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Uplink_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownstreamNetworkHardware": { + "get": { + "description": "All network hardware downstream from the selected piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDownstreamNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownstreamNetworkHardwareWithIncidents": { + "get": { + "description": "All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardwareWithIncidents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDownstreamNetworkHardwareWithIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownstreamServers": { + "get": { + "description": "Information regarding all servers attached downstream to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamServers/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDownstreamServers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownstreamVirtualGuests": { + "get": { + "description": "Information regarding all virtual guests attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamVirtualGuests/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDownstreamVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDriveControllers": { + "get": { + "description": "The drive controllers contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getDriveControllers/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getDriveControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getEvaultNetworkStorage": { + "get": { + "description": "Information regarding a piece of hardware's associated EVault network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getEvaultNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getEvaultNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getFirewallServiceComponent": { + "get": { + "description": "Information regarding a piece of hardware's firewall services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallServiceComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getFirewallServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getFixedConfigurationPreset": { + "get": { + "description": "Defines the fixed components in a fixed configuration bare metal server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getFixedConfigurationPreset/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getFixedConfigurationPreset", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getFrontendNetworkComponents": { + "get": { + "description": "A piece of hardware's front-end or public network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getFrontendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getFrontendRouters": { + "get": { + "description": "A hardware's frontend or public router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendRouters/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getFrontendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getFutureBillingItem": { + "get": { + "description": "Information regarding the future billing item for a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getFutureBillingItem/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getFutureBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getGlobalIdentifier": { + "get": { + "description": "A hardware's universally unique identifier.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getGlobalIdentifier/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getGlobalIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHardDrives": { + "get": { + "description": "The hard drives contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHardDrives/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHardDrives", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHardwareChassis": { + "get": { + "description": "The chassis that a piece of hardware is housed in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareChassis/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHardwareChassis", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Chassis" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHardwareFunction": { + "get": { + "description": "A hardware's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunction/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHardwareFunction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Function" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHardwareFunctionDescription": { + "get": { + "description": "A hardware's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunctionDescription/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHardwareFunctionDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHardwareState": { + "get": { + "description": "A hardware's power/transaction state.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareState/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHardwareState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHardwareStatus": { + "get": { + "description": "A hardware's status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareStatus/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHardwareStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHasTrustedPlatformModuleBillingItemFlag": { + "get": { + "description": "Determine in hardware object has TPM enabled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHasTrustedPlatformModuleBillingItemFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHasTrustedPlatformModuleBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHostIpsSoftwareComponent": { + "get": { + "description": "Information regarding a host IPS software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHostIpsSoftwareComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHostIpsSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getHourlyBillingFlag": { + "get": { + "description": "A server's hourly billing status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBillingFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getHourlyBillingFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getInboundBandwidthUsage": { + "get": { + "description": "The sum of all the inbound network traffic data for the last 30 days.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getInboundBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getInboundPublicBandwidthUsage": { + "get": { + "description": "The total public inbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getInboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getIsBillingTermChangeAvailableFlag": { + "get": { + "description": "Whether or not this hardware object is eligible to change to term billing.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getIsBillingTermChangeAvailableFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getIsBillingTermChangeAvailableFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getIsCloudReadyNodeCertified": { + "get": { + "description": "Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getIsCloudReadyNodeCertified/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getIsCloudReadyNodeCertified", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getLastTransaction": { + "get": { + "description": "Information regarding the last transaction a server performed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getLastTransaction/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getLastTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getLatestNetworkMonitorIncident": { + "get": { + "description": "A piece of hardware's latest network monitoring incident.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getLatestNetworkMonitorIncident/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getLatestNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getLocation": { + "get": { + "description": "Where a piece of hardware is located within SoftLayer's location hierarchy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getLocation/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getLocationPathString": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getLocationPathString/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getLocationPathString", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getLockboxNetworkStorage": { + "get": { + "description": "Information regarding a lockbox account associated with a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getLockboxNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getLockboxNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getManagedResourceFlag": { + "get": { + "description": "A flag indicating that the hardware is a managed resource.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getManagedResourceFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getManagedResourceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getMemory": { + "get": { + "description": "Information regarding a piece of hardware's memory.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getMemory/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getMemory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getMemoryCapacity": { + "get": { + "description": "The amount of memory a piece of hardware has, measured in gigabytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getMemoryCapacity/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getMemoryCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getMetricTrackingObject": { + "get": { + "description": "A piece of hardware's metric tracking object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObject/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getModules": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getModules/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getModules", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getMonitoringRobot": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringRobot/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getMonitoringRobot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Monitoring_Robot" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getMonitoringServiceComponent": { + "get": { + "description": "Information regarding a piece of hardware's network monitoring services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getMonitoringServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getMonitoringServiceEligibilityFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceEligibilityFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getMonitoringServiceEligibilityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getMotherboard": { + "get": { + "description": "Information regarding a piece of hardware's motherboard.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getMotherboard/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getMotherboard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkCards": { + "get": { + "description": "Information regarding a piece of hardware's network cards.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkCards/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkCards", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkComponents": { + "get": { + "description": "Returns a hardware's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkGatewayMember": { + "get": { + "description": "The gateway member if this device is part of a network gateway.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMember/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkGatewayMember", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkGatewayMemberFlag": { + "get": { + "description": "Whether or not this device is part of a network gateway.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMemberFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkGatewayMemberFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkManagementIpAddress": { + "get": { + "description": "A piece of hardware's network management IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkManagementIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkManagementIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkMonitorAttachedDownHardware": { + "get": { + "description": "All servers with failed monitoring that are attached downstream to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkMonitorAttachedDownHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkMonitorAttachedDownVirtualGuests": { + "get": { + "description": "Virtual guests that are attached downstream to a hardware that have failed monitoring", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownVirtualGuests/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkMonitorAttachedDownVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkMonitorIncidents": { + "get": { + "description": "The status of all of a piece of hardware's network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorIncidents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkMonitorIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkMonitors": { + "get": { + "description": "Information regarding a piece of hardware's network monitors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitors/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkMonitors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkStatus": { + "get": { + "description": "The value of a hardware's network status attribute. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatus/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkStatusAttribute": { + "get": { + "description": "The hardware's related network status attribute. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatusAttribute/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkStatusAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkStorage": { + "get": { + "description": "Information regarding a piece of hardware's associated network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStorage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkVlans": { + "get": { + "description": "The network virtual LANs (VLANs) associated with a piece of hardware's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkVlans/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNextBillingCycleBandwidthAllocation": { + "get": { + "description": "A hardware's allotted bandwidth for the next billing cycle (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNextBillingCycleBandwidthAllocation/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNextBillingCycleBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNotesHistory": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNotesHistory/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNotesHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Note" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNvRamCapacity": { + "get": { + "description": "The amount of non-volatile memory a piece of hardware has, measured in gigabytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamCapacity/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNvRamCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNvRamComponentModels": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamComponentModels/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getNvRamComponentModels", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getOperatingSystem": { + "get": { + "description": "Information regarding a piece of hardware's operating system.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystem/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_OperatingSystem" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getOperatingSystemReferenceCode": { + "get": { + "description": "A hardware's operating system software description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystemReferenceCode/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getOperatingSystemReferenceCode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getOutboundBandwidthUsage": { + "get": { + "description": "The sum of all the outbound network traffic data for the last 30 days.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getOutboundBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getOutboundPublicBandwidthUsage": { + "get": { + "description": "The total public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getOutboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getParentBay": { + "get": { + "description": "Blade Bay", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getParentBay/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getParentBay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Blade" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getParentHardware": { + "get": { + "description": "Parent Hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getParentHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getParentHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPointOfPresenceLocation": { + "get": { + "description": "Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPointOfPresenceLocation/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPointOfPresenceLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPowerComponents": { + "get": { + "description": "The power components for a hardware object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPowerComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Power_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPowerSupply": { + "get": { + "description": "Information regarding a piece of hardware's power supply.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerSupply/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPowerSupply", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrimaryBackendIpAddress": { + "get": { + "description": "The hardware's primary private IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryBackendIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrimaryBackendIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrimaryBackendNetworkComponent": { + "get": { + "description": "Information regarding the hardware's primary back-end network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryBackendNetworkComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrimaryBackendNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrimaryIpAddress": { + "get": { + "description": "The hardware's primary public IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryIpAddress/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrimaryIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrimaryNetworkComponent": { + "get": { + "description": "Information regarding the hardware's primary public network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryNetworkComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrimaryNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrivateNetworkOnlyFlag": { + "get": { + "description": "Whether the hardware only has access to the private network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkOnlyFlag/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getPrivateNetworkOnlyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getProcessorCoreAmount": { + "get": { + "description": "The total number of processor cores, summed from all processors that are attached to a piece of hardware", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorCoreAmount/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getProcessorCoreAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getProcessorPhysicalCoreAmount": { + "get": { + "description": "The total number of physical processor cores, summed from all processors that are attached to a piece of hardware", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorPhysicalCoreAmount/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getProcessorPhysicalCoreAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getProcessors": { + "get": { + "description": "Information regarding a piece of hardware's processors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessors/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getProcessors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRack": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRack/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRaidControllers": { + "get": { + "description": "The RAID controllers contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRaidControllers/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRaidControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRecentEvents": { + "get": { + "description": "Recent events that impact this hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentEvents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRecentEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRemoteManagementAccounts": { + "get": { + "description": "User credentials to issue commands and/or interact with the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementAccounts/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRemoteManagementAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_User" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRemoteManagementComponent": { + "get": { + "description": "A hardware's associated remote management component. This is normally IPMI.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementComponent/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRemoteManagementComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getResourceConfigurations": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceConfigurations/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getResourceConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Resource_Configuration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getResourceGroupMemberReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupMemberReferences/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getResourceGroupMemberReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group_Member" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getResourceGroupRoles": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupRoles/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getResourceGroupRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group_Role" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getResourceGroups": { + "get": { + "description": "The resource groups in which this hardware is a member.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroups/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getResourceGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getRouters": { + "get": { + "description": "A hardware's routers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getRouters/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getSecurityScanRequests": { + "get": { + "description": "Information regarding a piece of hardware's vulnerability scan requests.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getSecurityScanRequests/", + "operationId": "SoftLayer_Hardware_SecurityModule750::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_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getServerRoom": { + "get": { + "description": "Information regarding the server room in which the hardware is located.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getServerRoom/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getServerRoom", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getServiceProvider": { + "get": { + "description": "Information regarding the piece of hardware's service provider.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getServiceProvider/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getServiceProvider", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Service_Provider" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getSoftwareComponents": { + "get": { + "description": "Information regarding a piece of hardware's installed software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getSoftwareComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getSparePoolBillingItem": { + "get": { + "description": "Information regarding the billing item for a spare pool server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getSparePoolBillingItem/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getSparePoolBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getSshKeys": { + "get": { + "description": "SSH keys to be installed on the server during provisioning or an OS reload.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getSshKeys/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getSshKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getStorageGroups": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageGroups/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getStorageNetworkComponents": { + "get": { + "description": "A piece of hardware's private storage network components. [Deprecated]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getStorageNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getTagReferences/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getTopLevelLocation": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getTopLevelLocation/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getTopLevelLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getUpgradeRequest": { + "get": { + "description": "An account's associated upgrade request object, if any.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeRequest/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getUpgradeRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Upgrade_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getUpgradeableActiveComponents": { + "get": { + "description": "A piece of hardware's active upgradeable physical components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeableActiveComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getUpgradeableActiveComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getUplinkHardware": { + "get": { + "description": "The network device connected to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkHardware/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getUplinkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getUplinkNetworkComponents": { + "get": { + "description": "Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkNetworkComponents/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getUplinkNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getUserData": { + "get": { + "description": "An array containing a single string of custom user data for a hardware order. Max size is 16 kb.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getUserData/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getUserData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getVirtualChassis": { + "get": { + "description": "Information regarding the virtual chassis for a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassis/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getVirtualChassis", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getVirtualChassisSiblings": { + "get": { + "description": "Information regarding the virtual chassis siblings for a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassisSiblings/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getVirtualChassisSiblings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getVirtualHost": { + "get": { + "description": "A piece of hardware's virtual host record.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualHost/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getVirtualHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getVirtualLicenses": { + "get": { + "description": "Information regarding a piece of hardware's virtual software licenses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualLicenses/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getVirtualLicenses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_VirtualLicense" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getVirtualRack": { + "get": { + "description": "Information regarding the bandwidth allotment to which a piece of hardware belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRack/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getVirtualRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getVirtualRackId": { + "get": { + "description": "The name of the bandwidth allotment belonging to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackId/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getVirtualRackId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getVirtualRackName": { + "get": { + "description": "The name of the bandwidth allotment belonging to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackName/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getVirtualRackName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getVirtualizationPlatform": { + "get": { + "description": "A piece of hardware's virtualization platform software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualizationPlatform/", + "operationId": "SoftLayer_Hardware_SecurityModule750::getVirtualizationPlatform", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/activatePrivatePort": { + "get": { + "description": "Activate a server's private network interface to the maximum available speed. This operation is an alias for [[SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed]] with a $newSpeed of -1 and a $redundancy of \"redundant\" or unspecified (which results in the best available redundancy state). \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending. ", + "summary": "Activate a server's private network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/activatePrivatePort/", + "operationId": "SoftLayer_Hardware_Server::activatePrivatePort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/activatePublicPort": { + "get": { + "description": "Activate a server's public network interface to the maximum available speed. This operation is an alias for [[SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed]] with a $newSpeed of -1 and a $redundancy of \"redundant\" or unspecified (which results in the best available redundancy state). \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending. ", + "summary": "Activate a server's public network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/activatePublicPort/", + "operationId": "SoftLayer_Hardware_Server::activatePublicPort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/bootToRescueLayer": { + "post": { + "description": "The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server. ", + "summary": "Initiates the Rescue Kernel to bring a server online to troubleshoot system problems.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/bootToRescueLayer/", + "operationId": "SoftLayer_Hardware_Server::bootToRescueLayer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/changeRedfishPowerState": { + "post": { + "description": "Changes the power state for the server. The server's power status is changed from its remote management card. ", + "summary": "Changes server's power state using Redfish", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/changeRedfishPowerState/", + "operationId": "SoftLayer_Hardware_Server::changeRedfishPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/createFirmwareReflashTransaction": { + "post": { + "description": "You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress. \n\nIn the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware reflash on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/createFirmwareReflashTransaction/", + "operationId": "SoftLayer_Hardware_Server::createFirmwareReflashTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/createFirmwareUpdateTransaction": { + "post": { + "description": "You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware updates on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/createFirmwareUpdateTransaction/", + "operationId": "SoftLayer_Hardware_Server::createFirmwareUpdateTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/createHyperThreadingUpdateTransaction": { + "post": { + "description": "You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress. \n\nIn the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs BIOS update on the server to change the hyper-threading configuration.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/createHyperThreadingUpdateTransaction/", + "operationId": "SoftLayer_Hardware_Server::createHyperThreadingUpdateTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/createObject": { + "post": { + "description": "\n \ncreateObject() enables the creation of servers on an account. This \nmethod is a simplified alternative to interacting with the ordering system directly. \n\n\nIn order to create a server, a template object must be sent in with a few required \nvalues. \n\n\nWhen this method returns an order will have been placed for a server of the specified configuration. \n\n\nTo determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]], \nchecking the 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 \n
    Hostname for the server.
      \n
    • Required
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
  • domain \n
    Domain for the server.
      \n
    • Required
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
  • processorCoreAmount \n
    The number of logical CPU cores to allocate.
      \n
    • Required
      • \n
    • Type - int
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n
    \n
    • \n
  • memoryCapacity \n
    The amount of memory to allocate in gigabytes.
      \n
    • Required
      • \n
    • Type - int
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n
    \n
    • \n
  • hourlyBillingFlag \n
    Specifies 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
    • \n
  • operatingSystemReferenceCode \n
    An 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
    • \n
  • datacenter.name \n
    Specifies which datacenter the server is to be provisioned in.
      \n
    • Required
      • \n
    • Type - string
      • \n
    • The datacenter property is a [[SoftLayer_Location (type)|location]] structure with the name field set.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"datacenter\": { \n \"name\": \"dal05\" \n } \n} \n
    \n
    • \n
  • networkComponents.maxSpeed \n
    Specifies 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 networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The maxSpeed property 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 { \n \"networkComponents\": [ \n { \n \"maxSpeed\": 1000 \n } \n ] \n} \n
    \n
    • \n
  • networkComponents.redundancyEnabledFlag \n
    Specifies whether or not the server's network components should be in redundancy groups.
      \n
    • Optional
      • \n
    • Type - bool
      • \n
    • Default - false
      • \n
    • Description - The networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the redundancyEnabledFlag property is true the server's network components will be in redundancy groups.
      • \n
    \n { \n \"networkComponents\": [ \n { \n \"redundancyEnabledFlag\": false \n } \n ] \n} \n
    \n
    • \n
  • privateNetworkOnlyFlag \n
    Specifies 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
    • \n
  • primaryNetworkComponent.networkVlan.id \n
    Specifies the network vlan which is to be used for the frontend interface of the server.
      \n
    • Optional
      • \n
    • Type - int
      • \n
    • Description - The primaryNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the frontend network vlan of the server.
      • \n
    \n { \n \"primaryNetworkComponent\": { \n \"networkVlan\": { \n \"id\": 1 \n } \n } \n} \n
    \n
    • \n
  • primaryBackendNetworkComponent.networkVlan.id \n
    Specifies the network vlan which is to be used for the backend interface of the server.
      \n
    • Optional
      • \n
    • Type - int
      • \n
    • Description - The primaryBackendNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the backend network vlan of the server.
      • \n
    \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 fixedConfigurationPreset property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The keyName property must be set to specify preset to use.
      • \n
    • If a fixed configuration preset is used processorCoreAmount, memoryCapacity and hardDrives properties must not be set.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"fixedConfigurationPreset\": { \n \"keyName\": \"SOME_KEY_NAME\" \n } \n} \n
    \n
    • \n
  • userData.value \n
    Arbitrary data to be made available to the server.
      \n
    • Optional
      • \n
    • Type - string
      • \n
    • Description - The userData property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the value property 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 { \n \"userData\": [ \n { \n \"value\": \"someValue\" \n } \n ] \n} \n
    \n
    • \n
  • hardDrives \n
    Hard 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 hardDrives property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures. \n
    • Each hard drive must specify the capacity property.
      • \n
    • See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
      • \n
    \n { \n \"hardDrives\": [ \n { \n \"capacity\": 500 \n } \n ] \n} \n
    \n
    • \n
  • sshKeys \n
    SSH 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 sshKeys property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the id property 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 { \n \"sshKeys\": [ \n { \n \"id\": 123 \n } \n ] \n} \n
    \n
    • \n
  • postInstallScriptUri \n
    Specifies the uri location of the script to be downloaded and run after installation is complete.
      \n
    • Optional
      • \n
    • Type - string
      • \n
    \n
    \n
    • \n
\n\n\n

REST Example

\ncurl -X POST -d '{ \n \"parameters\":[ \n { \n \"hostname\": \"host1\", \n \"domain\": \"example.com\", \n \"processorCoreAmount\": 2, \n \"memoryCapacity\": 2, \n \"hourlyBillingFlag\": true, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\" \n } \n ] \n}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json \n \nHTTP/1.1 201 Created \nLocation: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject \n\n\n{ \n \"accountId\": 232298, \n \"bareMetalInstanceFlag\": null, \n \"domain\": \"example.com\", \n \"hardwareStatusId\": null, \n \"hostname\": \"host1\", \n \"id\": null, \n \"serviceProviderId\": null, \n \"serviceProviderResourceId\": null, \n \"globalIdentifier\": \"f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5\", \n \"hourlyBillingFlag\": true, \n \"memoryCapacity\": 2, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\", \n \"processorCoreAmount\": 2 \n} \n ", + "summary": "Create a new server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/createObject/", + "operationId": "SoftLayer_Hardware_Server::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Server" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/createPostSoftwareInstallTransaction": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/createPostSoftwareInstallTransaction/", + "operationId": "SoftLayer_Hardware_Server::createPostSoftwareInstallTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/editObject": { + "post": { + "description": "Edit a server's properties ", + "summary": "Edit a server's properties", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/editObject/", + "operationId": "SoftLayer_Hardware_Server::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBackendBandwidthUsage": { + "post": { + "description": "Use this method to return an array of private bandwidth utilization records between a given date range. \n\nThis method represents the NEW version of getFrontendBandwidthUse ", + "summary": "Retrieves public bandwidth usage records.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getBackendBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBandwidthForDateRange/", + "operationId": "SoftLayer_Hardware_Server::getBandwidthForDateRange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBandwidthImage": { + "post": { + "description": "Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image. ", + "summary": "Retrieve a bandwidth image and textual description of that image for this server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBandwidthImage/", + "operationId": "SoftLayer_Hardware_Server::getBandwidthImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBootModeOptions": { + "get": { + "description": "Retrieve the valid boot modes for this server ", + "summary": "Retrieve the valid boot modes for this server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBootModeOptions/", + "operationId": "SoftLayer_Hardware_Server::getBootModeOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getCurrentBenchmarkCertificationResultFile": { + "get": { + "description": "Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception. ", + "summary": "Get the file for the current benchmark certification result, if it exists.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getCurrentBenchmarkCertificationResultFile/", + "operationId": "SoftLayer_Hardware_Server::getCurrentBenchmarkCertificationResultFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getFirewallProtectableSubnets": { + "get": { + "description": "Get the subnets associated with this server that are protectable by a network component firewall. ", + "summary": "Get the subnets associated with this server that are protectable by a network component firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getFirewallProtectableSubnets/", + "operationId": "SoftLayer_Hardware_Server::getFirewallProtectableSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getFrontendBandwidthUsage": { + "post": { + "description": "Use this method to return an array of public bandwidth utilization records between a given date range. \n\nThis method represents the NEW version of getFrontendBandwidthUse ", + "summary": "Retrieves public bandwidth usage records.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getFrontendBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/getHardwareByIpAddress": { + "post": { + "description": "Retrieve a server by searching for the primary IP address. ", + "summary": "Retrieve a SoftLayer_Hardware_Server object by IP address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHardwareByIpAddress/", + "operationId": "SoftLayer_Hardware_Server::getHardwareByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Server" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getItemPricesFromSoftwareDescriptions": { + "post": { + "description": "Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description", + "summary": "Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getItemPricesFromSoftwareDescriptions/", + "operationId": "SoftLayer_Hardware_Server::getItemPricesFromSoftwareDescriptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getManagementNetworkComponent": { + "get": { + "description": "Retrieve the remote management network component attached with this server. ", + "summary": "Retrieve a server's management network component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getManagementNetworkComponent/", + "operationId": "SoftLayer_Hardware_Server::getManagementNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkComponentFirewallProtectableIpAddresses": { + "get": { + "description": "Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this server. Please use getFirewallProtectableSubnets to get all protectable subnets. ", + "summary": "Get the IP addresses associated with this server that are protectable by a network component firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkComponentFirewallProtectableIpAddresses/", + "operationId": "SoftLayer_Hardware_Server::getNetworkComponentFirewallProtectableIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Hardware_Server object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve servers from the account that your portal user is assigned to. ", + "summary": "Retrieve a SoftLayer_Hardware_Server record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getObject/", + "operationId": "SoftLayer_Hardware_Server::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Server" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPMInfo": { + "get": { + "description": "Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires. ", + "summary": "Retrieve a server's hardware state via its internal sensors.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPMInfo/", + "operationId": "SoftLayer_Hardware_Server::getPMInfo", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_PmInfo" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrimaryDriveSize": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrimaryDriveSize/", + "operationId": "SoftLayer_Hardware_Server::getPrimaryDriveSize", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateBandwidthDataSummary": { + "get": { + "description": "Retrieve a brief summary of a server's private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period. ", + "summary": "Retrieve a server's private bandwidth usage summary", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthDataSummary/", + "operationId": "SoftLayer_Hardware_Server::getPrivateBandwidthDataSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Bandwidth_Data_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateBandwidthGraphImage": { + "post": { + "description": "Retrieve a graph of a server's private network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image ", + "summary": "Retrieve a graph of a server's private network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthGraphImage/", + "operationId": "SoftLayer_Hardware_Server::getPrivateBandwidthGraphImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateNetworkComponent": { + "get": { + "description": "Retrieve the private network component attached with this server. ", + "summary": "Retrieve a server's private network component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkComponent/", + "operationId": "SoftLayer_Hardware_Server::getPrivateNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateVlan": { + "get": { + "description": "Retrieve the backend VLAN for the primary IP address of the server ", + "summary": "Retrieve the backend VLAN for the primary IP address of the server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrivateVlan/", + "operationId": "SoftLayer_Hardware_Server::getPrivateVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/getPrivateVlanByIpAddress": { + "post": { + "description": "\n*** DEPRECATED ***\nRetrieve a backend network VLAN by searching for an IP address ", + "summary": "Retrieve a backend network VLAN by searching for an IP address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress/", + "operationId": "SoftLayer_Hardware_Server::getPrivateVlanByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getProvisionDate": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getProvisionDate/", + "operationId": "SoftLayer_Hardware_Server::getProvisionDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPublicBandwidthDataSummary": { + "get": { + "description": "Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period. ", + "summary": "Retrieve a server's public bandwidth usage summary", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthDataSummary/", + "operationId": "SoftLayer_Hardware_Server::getPublicBandwidthDataSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Bandwidth_Data_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPublicBandwidthGraphImage": { + "post": { + "description": "Retrieve a graph of a server's public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY. ", + "summary": "Retrieve a graph of a server's public network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthGraphImage/", + "operationId": "SoftLayer_Hardware_Server::getPublicBandwidthGraphImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPublicBandwidthTotal": { + "post": { + "description": "Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware. ", + "summary": "Retrieve total number of public bytes used by a server over time period specified.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthTotal/", + "operationId": "SoftLayer_Hardware_Server::getPublicBandwidthTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPublicNetworkComponent": { + "get": { + "description": "Retrieve a SoftLayer server's public network component. Some servers are only connected to the private network and may not have a public network component. In that case getPublicNetworkComponent returns a null object. ", + "summary": "Retrieve a server's public network component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPublicNetworkComponent/", + "operationId": "SoftLayer_Hardware_Server::getPublicNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPublicVlan": { + "get": { + "description": "Retrieve the frontend VLAN for the primary IP address of the server ", + "summary": "Retrieve the frontend VLAN for the primary IP address of the server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPublicVlan/", + "operationId": "SoftLayer_Hardware_Server::getPublicVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/getPublicVlanByHostname": { + "post": { + "description": "Retrieve the frontend network Vlan by searching the hostname of a server ", + "summary": "Retrieve the frontend VLAN by a server's hostname.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPublicVlanByHostname/", + "operationId": "SoftLayer_Hardware_Server::getPublicVlanByHostname", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRedfishPowerState": { + "get": { + "description": "Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'. ", + "summary": "Retrieves server's power state using Redfish", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRedfishPowerState/", + "operationId": "SoftLayer_Hardware_Server::getRedfishPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getReverseDomainRecords": { + "get": { + "description": "Retrieve the reverse domain records associated with this server. ", + "summary": "Retrieve the reverse domain records associated with a server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getReverseDomainRecords/", + "operationId": "SoftLayer_Hardware_Server::getReverseDomainRecords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Dns_Domain" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getSensorData": { + "get": { + "description": "Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires. ", + "summary": "Retrieve a server's hardware state via its internal sensors.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getSensorData/", + "operationId": "SoftLayer_Hardware_Server::getSensorData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_SensorReading" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getSensorDataWithGraphs": { + "get": { + "description": "Retrieves the raw data returned from the server's remote management card. For more details of what is returned please refer to the getSensorData method. Along with the raw data, graphs for the cpu and system temperatures and fan speeds are also returned. ", + "summary": "Retrieve server's temperature and fan speed graphs as well the sensor raw data.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getSensorDataWithGraphs/", + "operationId": "SoftLayer_Hardware_Server::getSensorDataWithGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getServerDetails": { + "get": { + "description": "Retrieve a server's hardware components, software, and network components. getServerDetails is an aggregation function that combines the results of [[SoftLayer_Hardware_Server::getComponents]], [[SoftLayer_Hardware_Server::getSoftware]], and [[SoftLayer_Hardware_Server::getNetworkComponents]] in a single container. ", + "summary": "Retrieve a server's hardware components, software, and network components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getServerDetails/", + "operationId": "SoftLayer_Hardware_Server::getServerDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Details" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getServerFanSpeedGraphs": { + "get": { + "description": "Retrieve the server's fan speeds and displays them using tachometer graphs. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it. ", + "summary": "Retrieve server's fan speed graphs.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getServerFanSpeedGraphs/", + "operationId": "SoftLayer_Hardware_Server::getServerFanSpeedGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getServerPowerState": { + "get": { + "description": "Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'. ", + "summary": "Retrieves server's power state", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getServerPowerState/", + "operationId": "SoftLayer_Hardware_Server::getServerPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getServerTemperatureGraphs": { + "get": { + "description": "Retrieve the server's temperature and displays them using thermometer graphs. Temperatures retrieved are CPU(s) and system temperatures. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it. ", + "summary": "Retrieve server's temperature graphs", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getServerTemperatureGraphs/", + "operationId": "SoftLayer_Hardware_Server::getServerTemperatureGraphs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getValidBlockDeviceTemplateGroups": { + "post": { + "description": "This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images. ", + "summary": "Return a list of valid block device template groups based on this host", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getValidBlockDeviceTemplateGroups/", + "operationId": "SoftLayer_Hardware_Server::getValidBlockDeviceTemplateGroups", + "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_Hardware_Server/{SoftLayer_Hardware_ServerID}/getWindowsUpdateAvailableUpdates": { + "get": { + "description": "Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default. ", + "summary": "Retrieve a list of Windows updates available to a server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateAvailableUpdates/", + "operationId": "SoftLayer_Hardware_Server::getWindowsUpdateAvailableUpdates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getWindowsUpdateInstalledUpdates": { + "get": { + "description": "Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default. ", + "summary": "Retrieve a list of Windows updates installed on a server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateInstalledUpdates/", + "operationId": "SoftLayer_Hardware_Server::getWindowsUpdateInstalledUpdates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getWindowsUpdateStatus": { + "get": { + "description": "This method returns an update status record for this server. That record will specify if the server is missing updates, or has updates that must be reinstalled or require a reboot to go into affect. ", + "summary": "Retrieve a server's Windows update synchronization status", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateStatus/", + "operationId": "SoftLayer_Hardware_Server::getWindowsUpdateStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/initiateIderaBareMetalRestore": { + "get": { + "description": "Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup. ", + "summary": "Initiate an Idera bare metal restore for the server tied to an Idera Server Backup", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/initiateIderaBareMetalRestore/", + "operationId": "SoftLayer_Hardware_Server::initiateIderaBareMetalRestore", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/initiateR1SoftBareMetalRestore": { + "get": { + "description": "R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup. ", + "summary": "Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/initiateR1SoftBareMetalRestore/", + "operationId": "SoftLayer_Hardware_Server::initiateR1SoftBareMetalRestore", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/isBackendPingable": { + "get": { + "description": "Issues a ping command and returns the success (true) or failure (false) of the ping command. ", + "summary": "Verifies if a server's backend ip address is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/isBackendPingable/", + "operationId": "SoftLayer_Hardware_Server::isBackendPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/isPingable": { + "get": { + "description": "Issues a ping command and returns the success (true) or failure (false) of the ping command. ", + "summary": "Verifies if server is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/isPingable/", + "operationId": "SoftLayer_Hardware_Server::isPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/isWindowsServer": { + "get": { + "description": "Determine if the server runs any version of the Microsoft Windows operating systems. Return ''true'' if it does and ''false if otherwise. ", + "summary": "Determine if a server runs the Microsoft Windows operating system.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/isWindowsServer/", + "operationId": "SoftLayer_Hardware_Server::isWindowsServer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/massFirmwareReflash": { + "post": { + "description": "You can launch firmware reflashes by selecting from your server list. It will bring your server offline for approximately 60 minutes while the reflashes are in progress. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be contact you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware reflashes on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/massFirmwareReflash/", + "operationId": "SoftLayer_Hardware_Server::massFirmwareReflash", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/massFirmwareUpdate": { + "post": { + "description": "You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware updates on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/massFirmwareUpdate/", + "operationId": "SoftLayer_Hardware_Server::massFirmwareUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/massHyperThreadingUpdate": { + "post": { + "description": "You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the updates are in progress. \n\nIn the event of a hardware failure during this update our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be in contact with you to ensure that impact on your server is minimal. ", + "summary": "Runs firmware reflashes on the servers components.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/massHyperThreadingUpdate/", + "operationId": "SoftLayer_Hardware_Server::massHyperThreadingUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/massReloadOperatingSystem": { + "post": { + "description": "Reloads current or customer specified operating system configuration. \n\nThis service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server. \n\nAs a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record. \n\nThe reload will take AT MINIMUM 66 minutes. ", + "summary": "Reloads operating system configuration on a set of hardware Ids.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/massReloadOperatingSystem/", + "operationId": "SoftLayer_Hardware_Server::massReloadOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/massSparePool": { + "post": { + "description": "The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program. ", + "summary": "Allows multiple servers to be added to or removed from the spare pool.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/massSparePool/", + "operationId": "SoftLayer_Hardware_Server::massSparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Server_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/ping": { + "get": { + "description": "Issues a ping command to the server and returns the ping response. ", + "summary": "Issues ping command.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/ping/", + "operationId": "SoftLayer_Hardware_Server::ping", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/populateServerRam": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/populateServerRam/", + "operationId": "SoftLayer_Hardware_Server::populateServerRam", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/powerCycle": { + "get": { + "description": "Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Issues power cycle to server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/powerCycle/", + "operationId": "SoftLayer_Hardware_Server::powerCycle", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/powerOff": { + "get": { + "description": "This method will power off the server via the server's remote management card. ", + "summary": "Power off server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/powerOff/", + "operationId": "SoftLayer_Hardware_Server::powerOff", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/powerOn": { + "get": { + "description": "Power on server via its remote management card. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Power on server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/powerOn/", + "operationId": "SoftLayer_Hardware_Server::powerOn", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/rebootDefault": { + "get": { + "description": "Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card. If the reset (soft reboot) attempt is unsuccessful, a power cycle command will be issued via the powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Reboot the server via the default method.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/rebootDefault/", + "operationId": "SoftLayer_Hardware_Server::rebootDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/rebootHard": { + "get": { + "description": "Reboot the server by issuing a cycle command to the server's remote management card. This is equivalent to pressing the 'Reset' button on the server. This command is issued immediately and will not wait for processes to shutdown. After this command is issued, the server may take a few moments to boot up as server may run system disks checks. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Reboot the server via \"hard\" reboot.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/rebootHard/", + "operationId": "SoftLayer_Hardware_Server::rebootHard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/rebootSoft": { + "get": { + "description": "Reboot the server by issuing a reset command to the server's remote management card. This is a graceful reboot. The servers will allow all process to shutdown gracefully before rebooting. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures. ", + "summary": "Reboot the server via gracefully (soft reboot).", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/rebootSoft/", + "operationId": "SoftLayer_Hardware_Server::rebootSoft", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/reloadCurrentOperatingSystemConfiguration": { + "post": { + "description": "Reloads current operating system configuration. \n\nThis service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server. \n\nAs a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record. \n\nThe reload will take AT MINIMUM 66 minutes. ", + "summary": "Reloads current operating system configuration.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/reloadCurrentOperatingSystemConfiguration/", + "operationId": "SoftLayer_Hardware_Server::reloadCurrentOperatingSystemConfiguration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/reloadOperatingSystem": { + "post": { + "description": "Reloads current or customer specified operating system configuration. \n\nThis service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server. \n\nAs a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record. \n\nThe reload will take AT MINIMUM 66 minutes. ", + "summary": "Reloads operating system configuration.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/reloadOperatingSystem/", + "operationId": "SoftLayer_Hardware_Server::reloadOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/runPassmarkCertificationBenchmark": { + "get": { + "description": "You can launch a new Passmark hardware test by selecting from your server list. It will bring your server offline for approximately 20 minutes while the testing is in progress, and will publish a certificate with the results to your hardware details page. \n\nWhile the hard drives are tested for the initial deployment, the Passmark Certificate utility will not test the hard drives on your live server. This is to ensure that no data is overwritten. If you would like to test the server's hard drives, you can have the full Passmark suite installed to your server free of charge through a new Support ticket. \n\nWhile the test itself does not overwrite any data on the server, it is recommended that you make full off-server backups of all data prior to launching the test. The Passmark hardware test is designed to force any latent hardware issues to the surface, so hardware failure is possible. \n\nIn the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal. ", + "summary": "Runs a hardware stress test on the server to obtain a Passmark Certification.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/runPassmarkCertificationBenchmark/", + "operationId": "SoftLayer_Hardware_Server::runPassmarkCertificationBenchmark", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/setOperatingSystemPassword": { + "post": { + "description": "Changes the password that we have stored in our database for a servers' Operating System", + "summary": "Changes the password stored in our system for a servers' Operating System", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/setOperatingSystemPassword/", + "operationId": "SoftLayer_Hardware_Server::setOperatingSystemPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/setPrivateNetworkInterfaceSpeed": { + "post": { + "description": "Set the private network interface speed and redundancy configuration. \n\nPossible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available. \n\nIf specified, possible $redundancy values are either \"redundant\" or \"degraded\". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. \"redundant\" indicates all available interfaces should be active. \"degraded\" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending. \n\n

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\".
After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1. ", + "summary": "Set the speed and redundancy configuration of a server's private network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed/", + "operationId": "SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/setPublicNetworkInterfaceSpeed": { + "post": { + "description": "Set the public network interface speed and redundancy configuration. \n\nPossible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available. \n\nIf specified, possible $redundancy values are either \"redundant\" or \"degraded\". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. \"redundant\" indicates all available interfaces should be active. \"degraded\" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending. \n\n

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\".
After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1. ", + "summary": "Set the speed and redundancy configuration of a server's public network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed/", + "operationId": "SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/setUserMetadata": { + "post": { + "description": "Sets the data that will be written to the configuration drive. ", + "summary": "Sets the server's user metadata value.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/setUserMetadata/", + "operationId": "SoftLayer_Hardware_Server::setUserMetadata", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/shutdownPrivatePort": { + "get": { + "description": "Disconnect a server's private network interface. This operation is an alias for calling [[SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed]] with a $newSpeed of 0 and unspecified $redundancy. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending. ", + "summary": "Disconnect a server's private network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/shutdownPrivatePort/", + "operationId": "SoftLayer_Hardware_Server::shutdownPrivatePort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/shutdownPublicPort": { + "get": { + "description": "Disconnect a server's public network interface. This operation is an alias for [[SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed]] with a $newSpeed of 0 and unspecified $redundancy. \n\nReceipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. \n\nA response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending. ", + "summary": "Disconnect a server's public network interface.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/shutdownPublicPort/", + "operationId": "SoftLayer_Hardware_Server::shutdownPublicPort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/sparePool": { + "post": { + "description": "The ability to place bare metal servers in a state where they are powered down, and ports closed yet still allocated to the customer as a part of the Spare Pool program. ", + "summary": "Allows servers to be added to or removed from the spare pool.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/sparePool/", + "operationId": "SoftLayer_Hardware_Server::sparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/testRaidAlertService": { + "get": { + "description": "Test the RAID Alert service by sending the service a request to store a test email for this server. The server must have an account ID and MAC address. A RAID controller must also be installed. ", + "summary": "Tests the RAID Alert service.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/testRaidAlertService/", + "operationId": "SoftLayer_Hardware_Server::testRaidAlertService", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/toggleManagementInterface": { + "post": { + "description": "Attempt to toggle the IPMI interface. If there is an active transaction on the server, it will throw an exception. This method creates a job to toggle the interface. It is not instant. ", + "summary": "Toggle the IPMI interface on and off.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/toggleManagementInterface/", + "operationId": "SoftLayer_Hardware_Server::toggleManagementInterface", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/updateIpmiPassword": { + "post": { + "description": "This method will update the root IPMI password on this SoftLayer_Hardware. ", + "summary": "Update the root IPMI user password ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/updateIpmiPassword/", + "operationId": "SoftLayer_Hardware_Server::updateIpmiPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/validatePartitionsForOperatingSystem": { + "post": { + "description": "Validates a collection of partitions for an operating system", + "summary": "Validates a collection of partitions for an operating system", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/validatePartitionsForOperatingSystem/", + "operationId": "SoftLayer_Hardware_Server::validatePartitionsForOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/validateSecurityLevel": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/validateSecurityLevel/", + "operationId": "SoftLayer_Hardware_Server::validateSecurityLevel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/allowAccessToNetworkStorage": { + "post": { + "description": "This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control. ", + "summary": "Allow access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorage/", + "operationId": "SoftLayer_Hardware_Server::allowAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/allowAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Allow access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorageList/", + "operationId": "SoftLayer_Hardware_Server::allowAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/captureImage": { + "post": { + "description": "Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image. ", + "summary": "Captures an Image of the hard disk on the physical machine.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/captureImage/", + "operationId": "SoftLayer_Hardware_Server::captureImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/deleteObject": { + "get": { + "description": "\nThis method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns. ", + "summary": "Delete a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/deleteObject/", + "operationId": "SoftLayer_Hardware_Server::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/deleteSoftwareComponentPasswords": { + "post": { + "description": "Delete software component passwords. ", + "summary": "Delete software component passwords.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/deleteSoftwareComponentPasswords/", + "operationId": "SoftLayer_Hardware_Server::deleteSoftwareComponentPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/deleteTag": { + "post": { + "description": "Delete an existing tag. If there are any references on the tag, an exception will be thrown. ", + "summary": "Delete a tag", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/deleteTag/", + "operationId": "SoftLayer_Hardware_Server::deleteTag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/editSoftwareComponentPasswords": { + "post": { + "description": "Edit the properties of a software component password such as the username, password, and notes. ", + "summary": "Edit the properties of software component passwords.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/editSoftwareComponentPasswords/", + "operationId": "SoftLayer_Hardware_Server::editSoftwareComponentPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/executeRemoteScript": { + "post": { + "description": "Download and run remote script from uri on the hardware.", + "summary": "Download and run remote script from uri on the hardware. Requires https for script to be executed after download. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/executeRemoteScript/", + "operationId": "SoftLayer_Hardware_Server::executeRemoteScript", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/findByIpAddress": { + "post": { + "description": "The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned. ", + "summary": "Find hardware by its primary public or private IP (ipv4) address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/findByIpAddress/", + "operationId": "SoftLayer_Hardware_Server::findByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/generateOrderTemplate": { + "post": { + "description": "\nObtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]]. \n\n\nThis is primarily useful when there is a necessity to confirm the price which will be charged for an order. \n\n\nSee [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter. ", + "summary": "Obtain an order container for a given template object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/generateOrderTemplate/", + "operationId": "SoftLayer_Hardware_Server::generateOrderTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAttachedNetworkStorages": { + "post": { + "description": "This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAttachedNetworkStorages/", + "operationId": "SoftLayer_Hardware_Server::getAttachedNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAvailableBillingTermChangePrices": { + "get": { + "description": "Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers. ", + "summary": "Retrieves a list of available term prices available to this of hardware. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAvailableBillingTermChangePrices/", + "operationId": "SoftLayer_Hardware_Server::getAvailableBillingTermChangePrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAvailableNetworkStorages": { + "post": { + "description": "This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAvailableNetworkStorages/", + "operationId": "SoftLayer_Hardware_Server::getAvailableNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBackendIncomingBandwidth": { + "post": { + "description": "The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes. ", + "summary": "Retrieve the amount of incoming private network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBackendIncomingBandwidth/", + "operationId": "SoftLayer_Hardware_Server::getBackendIncomingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBackendOutgoingBandwidth": { + "post": { + "description": "The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes. ", + "summary": "Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBackendOutgoingBandwidth/", + "operationId": "SoftLayer_Hardware_Server::getBackendOutgoingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getComponentDetailsXML": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getComponentDetailsXML/", + "operationId": "SoftLayer_Hardware_Server::getComponentDetailsXML", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/getCreateObjectOptions": { + "get": { + "description": "\nThere are many options that may be provided while ordering a server, this method can be used to determine what these options are. \n\n\nDetailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]]. ", + "summary": "Determine options available when creating a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getCreateObjectOptions/", + "operationId": "SoftLayer_Hardware_Server::getCreateObjectOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_Configuration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getCurrentBillingDetail": { + "get": { + "description": "Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage. ", + "summary": "<< EOT", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getCurrentBillingDetail/", + "operationId": "SoftLayer_Hardware_Server::getCurrentBillingDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getCurrentBillingTotal": { + "get": { + "description": "Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware. ", + "summary": "Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getCurrentBillingTotal/", + "operationId": "SoftLayer_Hardware_Server::getCurrentBillingTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDailyAverage": { + "post": { + "description": "The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day. ", + "summary": "calculate the average daily network traffic used by a server in gigabytes.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDailyAverage/", + "operationId": "SoftLayer_Hardware_Server::getDailyAverage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getFrontendIncomingBandwidth": { + "post": { + "description": "The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB). ", + "summary": "Retrieve the amount of incoming public network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getFrontendIncomingBandwidth/", + "operationId": "SoftLayer_Hardware_Server::getFrontendIncomingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getFrontendOutgoingBandwidth": { + "post": { + "description": "The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB). ", + "summary": "Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getFrontendOutgoingBandwidth/", + "operationId": "SoftLayer_Hardware_Server::getFrontendOutgoingBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHourlyBandwidth": { + "post": { + "description": "The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of \n\n'02/01/2008 0:00' \n\nresults in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time). \n\nFor data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware. ", + "summary": "Retrieves bandwidth hourly over a 24-hour period for the specified hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHourlyBandwidth/", + "operationId": "SoftLayer_Hardware_Server::getHourlyBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateBandwidthData": { + "post": { + "description": "Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. ", + "summary": "Retrieve a graph of a server's private network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthData/", + "operationId": "SoftLayer_Hardware_Server::getPrivateBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPublicBandwidthData": { + "post": { + "description": "Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. ", + "summary": "Retrieve a graph of a server's public network usage.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthData/", + "operationId": "SoftLayer_Hardware_Server::getPublicBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getTransactionHistory": { + "get": { + "description": "\nThis method will query transaction history for a piece of hardware. ", + "summary": "Get transaction history for a piece of hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getTransactionHistory/", + "operationId": "SoftLayer_Hardware_Server::getTransactionHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getUpgradeItemPrices": { + "get": { + "description": "Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs. ", + "summary": "Retrieve a list of upgradeable items available to a piece of hardware.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getUpgradeItemPrices/", + "operationId": "SoftLayer_Hardware_Server::getUpgradeItemPrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/importVirtualHost": { + "get": { + "description": "The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.", + "summary": "attempt to import the host record for the virtualization platform running on a server", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/importVirtualHost/", + "operationId": "SoftLayer_Hardware_Server::importVirtualHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/refreshDeviceStatus": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/refreshDeviceStatus/", + "operationId": "SoftLayer_Hardware_Server::refreshDeviceStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/removeAccessToNetworkStorage": { + "post": { + "description": "This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control. ", + "summary": "Remove access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorage/", + "operationId": "SoftLayer_Hardware_Server::removeAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/removeAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Remove access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorageList/", + "operationId": "SoftLayer_Hardware_Server::removeAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/removeTags": { + "post": { + "description": null, + "summary": "Remove a tag reference", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/removeTags/", + "operationId": "SoftLayer_Hardware_Server::removeTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/setTags": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/setTags/", + "operationId": "SoftLayer_Hardware_Server::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getActiveNetworkFirewallBillingItem": { + "get": { + "description": "The billing item for a server's attached network firewall.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getActiveNetworkFirewallBillingItem/", + "operationId": "SoftLayer_Hardware_Server::getActiveNetworkFirewallBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getActiveTickets": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getActiveTickets/", + "operationId": "SoftLayer_Hardware_Server::getActiveTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getActiveTransaction": { + "get": { + "description": "Transaction currently running for server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getActiveTransaction/", + "operationId": "SoftLayer_Hardware_Server::getActiveTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getActiveTransactions": { + "get": { + "description": "Any active transaction(s) that are currently running for the server (example: os reload).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getActiveTransactions/", + "operationId": "SoftLayer_Hardware_Server::getActiveTransactions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAvailableMonitoring": { + "get": { + "description": "An object that stores the maximum level for the monitoring query types and response types.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAvailableMonitoring/", + "operationId": "SoftLayer_Hardware_Server::getAvailableMonitoring", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAverageDailyBandwidthUsage": { + "get": { + "description": "The average daily total bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAverageDailyBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getAverageDailyBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAverageDailyPrivateBandwidthUsage": { + "get": { + "description": "The average daily private bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAverageDailyPrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getAverageDailyPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBillingCycleBandwidthUsage": { + "get": { + "description": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBillingCycleBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getBillingCycleBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBillingCyclePrivateBandwidthUsage": { + "get": { + "description": "The raw private bandwidth usage data for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBillingCyclePrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getBillingCyclePrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBillingCyclePublicBandwidthUsage": { + "get": { + "description": "The raw public bandwidth usage data for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBillingCyclePublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getBillingCyclePublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBiosPasswordNullFlag": { + "get": { + "description": "Determine if BIOS password should be left as null.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBiosPasswordNullFlag/", + "operationId": "SoftLayer_Hardware_Server::getBiosPasswordNullFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getCaptureEnabledFlag": { + "get": { + "description": "Determine if the server is able to be image captured. If unable to image capture a reason will be provided.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getCaptureEnabledFlag/", + "operationId": "SoftLayer_Hardware_Server::getCaptureEnabledFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Hardware_CaptureEnabled" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getContainsSolidStateDrivesFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getContainsSolidStateDrivesFlag/", + "operationId": "SoftLayer_Hardware_Server::getContainsSolidStateDrivesFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getControlPanel": { + "get": { + "description": "A server's control panel.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getControlPanel/", + "operationId": "SoftLayer_Hardware_Server::getControlPanel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_ControlPanel" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getCost": { + "get": { + "description": "The total cost of a server, measured in US Dollars ($USD).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getCost/", + "operationId": "SoftLayer_Hardware_Server::getCost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getCurrentBandwidthSummary": { + "get": { + "description": "An object that provides commonly used bandwidth summary components for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getCurrentBandwidthSummary/", + "operationId": "SoftLayer_Hardware_Server::getCurrentBandwidthSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getCustomerInstalledOperatingSystemFlag": { + "get": { + "description": "Indicates if a server has a Customer Installed OS", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getCustomerInstalledOperatingSystemFlag/", + "operationId": "SoftLayer_Hardware_Server::getCustomerInstalledOperatingSystemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getCustomerOwnedFlag": { + "get": { + "description": "Indicates if a server is a customer owned device.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getCustomerOwnedFlag/", + "operationId": "SoftLayer_Hardware_Server::getCustomerOwnedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHasSingleRootVirtualizationBillingItemFlag": { + "get": { + "description": "Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHasSingleRootVirtualizationBillingItemFlag/", + "operationId": "SoftLayer_Hardware_Server::getHasSingleRootVirtualizationBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getInboundPrivateBandwidthUsage": { + "get": { + "description": "The total private inbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getInboundPrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getInboundPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getIsIpmiDisabled": { + "get": { + "description": "Determine if remote management has been disabled due to port speed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getIsIpmiDisabled/", + "operationId": "SoftLayer_Hardware_Server::getIsIpmiDisabled", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getIsNfsOnly": { + "get": { + "description": "A server that has nfs only drive.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getIsNfsOnly/", + "operationId": "SoftLayer_Hardware_Server::getIsNfsOnly", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getIsQeInternalServer": { + "get": { + "description": "Determine if hardware object has the QE_INTERNAL_SERVER attribute.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getIsQeInternalServer/", + "operationId": "SoftLayer_Hardware_Server::getIsQeInternalServer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getIsVirtualPrivateCloudNode": { + "get": { + "description": "Determine if hardware object is a Virtual Private Cloud node.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getIsVirtualPrivateCloudNode/", + "operationId": "SoftLayer_Hardware_Server::getIsVirtualPrivateCloudNode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getLastOperatingSystemReload": { + "get": { + "description": "The last transaction that a server's operating system was loaded.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getLastOperatingSystemReload/", + "operationId": "SoftLayer_Hardware_Server::getLastOperatingSystemReload", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getLogicalVolumeStorageGroups": { + "get": { + "description": "Returns a list of logical volumes on the physical machine.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getLogicalVolumeStorageGroups/", + "operationId": "SoftLayer_Hardware_Server::getLogicalVolumeStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getMetricTrackingObjectId": { + "get": { + "description": "The metric tracking object id for this server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObjectId/", + "operationId": "SoftLayer_Hardware_Server::getMetricTrackingObjectId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getMonitoringUserNotification": { + "get": { + "description": "The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getMonitoringUserNotification/", + "operationId": "SoftLayer_Hardware_Server::getMonitoringUserNotification", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getOpenCancellationTicket": { + "get": { + "description": "An open ticket requesting cancellation of this server, if one exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getOpenCancellationTicket/", + "operationId": "SoftLayer_Hardware_Server::getOpenCancellationTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getOutboundPrivateBandwidthUsage": { + "get": { + "description": "The total private outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getOutboundPrivateBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getOutboundPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getOverBandwidthAllocationFlag": { + "get": { + "description": "Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getOverBandwidthAllocationFlag/", + "operationId": "SoftLayer_Hardware_Server::getOverBandwidthAllocationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPartitions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPartitions/", + "operationId": "SoftLayer_Hardware_Server::getPartitions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Server_Partition" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateBackendNetworkComponents": { + "get": { + "description": "A collection of backendNetwork components", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrivateBackendNetworkComponents/", + "operationId": "SoftLayer_Hardware_Server::getPrivateBackendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateIpAddress": { + "get": { + "description": "A server's primary private IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrivateIpAddress/", + "operationId": "SoftLayer_Hardware_Server::getPrivateIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getProjectedOverBandwidthAllocationFlag": { + "get": { + "description": "Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getProjectedOverBandwidthAllocationFlag/", + "operationId": "SoftLayer_Hardware_Server::getProjectedOverBandwidthAllocationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getProjectedPublicBandwidthUsage": { + "get": { + "description": "The projected public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getProjectedPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getProjectedPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getReadyNodeFlag": { + "get": { + "description": "Determine if hardware object is vSan Ready Node.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getReadyNodeFlag/", + "operationId": "SoftLayer_Hardware_Server::getReadyNodeFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRecentRemoteManagementCommands": { + "get": { + "description": "The last five commands issued to the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRecentRemoteManagementCommands/", + "operationId": "SoftLayer_Hardware_Server::getRecentRemoteManagementCommands", + "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_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRegionalInternetRegistry": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRegionalInternetRegistry/", + "operationId": "SoftLayer_Hardware_Server::getRegionalInternetRegistry", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Regional_Internet_Registry" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRemoteManagement": { + "get": { + "description": "A server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRemoteManagement/", + "operationId": "SoftLayer_Hardware_Server::getRemoteManagement", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRemoteManagementUsers": { + "get": { + "description": "User(s) who have access to issue commands and/or interact with the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRemoteManagementUsers/", + "operationId": "SoftLayer_Hardware_Server::getRemoteManagementUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_User" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getSoftwareGuardExtensionEnabled": { + "get": { + "description": "Determine if hardware object has Software Guard Extension (SGX) enabled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getSoftwareGuardExtensionEnabled/", + "operationId": "SoftLayer_Hardware_Server::getSoftwareGuardExtensionEnabled", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getStatisticsRemoteManagement": { + "get": { + "description": "A server's remote management card used for statistics.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getStatisticsRemoteManagement/", + "operationId": "SoftLayer_Hardware_Server::getStatisticsRemoteManagement", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getUefiBootFlag": { + "get": { + "description": "Whether to use UEFI boot instead of BIOS.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getUefiBootFlag/", + "operationId": "SoftLayer_Hardware_Server::getUefiBootFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getUsers": { + "get": { + "description": "A list of users that have access to this computing instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getUsers/", + "operationId": "SoftLayer_Hardware_Server::getUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getVirtualGuests": { + "get": { + "description": "[DEPRECATED] A hardware server's virtual servers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getVirtualGuests/", + "operationId": "SoftLayer_Hardware_Server::getVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAccount": { + "get": { + "description": "The account associated with a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAccount/", + "operationId": "SoftLayer_Hardware_Server::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getActiveComponents": { + "get": { + "description": "A piece of hardware's active physical components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getActiveComponents/", + "operationId": "SoftLayer_Hardware_Server::getActiveComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getActiveNetworkMonitorIncident": { + "get": { + "description": "A piece of hardware's active network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getActiveNetworkMonitorIncident/", + "operationId": "SoftLayer_Hardware_Server::getActiveNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAllPowerComponents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAllPowerComponents/", + "operationId": "SoftLayer_Hardware_Server::getAllPowerComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Power_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAllowedHost": { + "get": { + "description": "The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAllowedHost/", + "operationId": "SoftLayer_Hardware_Server::getAllowedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAllowedNetworkStorage": { + "get": { + "description": "The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorage/", + "operationId": "SoftLayer_Hardware_Server::getAllowedNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAllowedNetworkStorageReplicas": { + "get": { + "description": "The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorageReplicas/", + "operationId": "SoftLayer_Hardware_Server::getAllowedNetworkStorageReplicas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAntivirusSpywareSoftwareComponent": { + "get": { + "description": "Information regarding an antivirus/spyware software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAntivirusSpywareSoftwareComponent/", + "operationId": "SoftLayer_Hardware_Server::getAntivirusSpywareSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAttributes": { + "get": { + "description": "Information regarding a piece of hardware's specific attributes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAttributes/", + "operationId": "SoftLayer_Hardware_Server::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getAverageDailyPublicBandwidthUsage": { + "get": { + "description": "The average daily public bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getAverageDailyPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getAverageDailyPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBackendNetworkComponents": { + "get": { + "description": "A piece of hardware's back-end or private network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBackendNetworkComponents/", + "operationId": "SoftLayer_Hardware_Server::getBackendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBackendRouters": { + "get": { + "description": "A hardware's backend or private router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBackendRouters/", + "operationId": "SoftLayer_Hardware_Server::getBackendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBandwidthAllocation": { + "get": { + "description": "A hardware's allotted bandwidth (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBandwidthAllocation/", + "operationId": "SoftLayer_Hardware_Server::getBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBandwidthAllotmentDetail": { + "get": { + "description": "A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBandwidthAllotmentDetail/", + "operationId": "SoftLayer_Hardware_Server::getBandwidthAllotmentDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBenchmarkCertifications": { + "get": { + "description": "Information regarding a piece of hardware's benchmark certifications.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBenchmarkCertifications/", + "operationId": "SoftLayer_Hardware_Server::getBenchmarkCertifications", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Benchmark_Certification" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBillingItem": { + "get": { + "description": "Information regarding the billing item for a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBillingItem/", + "operationId": "SoftLayer_Hardware_Server::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBillingItemFlag": { + "get": { + "description": "A flag indicating that a billing item exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBillingItemFlag/", + "operationId": "SoftLayer_Hardware_Server::getBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBlockCancelBecauseDisconnectedFlag": { + "get": { + "description": "Determines whether the hardware is ineligible for cancellation because it is disconnected.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBlockCancelBecauseDisconnectedFlag/", + "operationId": "SoftLayer_Hardware_Server::getBlockCancelBecauseDisconnectedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBusinessContinuanceInsuranceFlag": { + "get": { + "description": "Status indicating whether or not a piece of hardware has business continuance insurance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getBusinessContinuanceInsuranceFlag/", + "operationId": "SoftLayer_Hardware_Server::getBusinessContinuanceInsuranceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getChildrenHardware": { + "get": { + "description": "Child hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getChildrenHardware/", + "operationId": "SoftLayer_Hardware_Server::getChildrenHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getComponents": { + "get": { + "description": "A piece of hardware's components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getComponents/", + "operationId": "SoftLayer_Hardware_Server::getComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getContinuousDataProtectionSoftwareComponent": { + "get": { + "description": "A continuous data protection/server backup software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getContinuousDataProtectionSoftwareComponent/", + "operationId": "SoftLayer_Hardware_Server::getContinuousDataProtectionSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getCurrentBillableBandwidthUsage": { + "get": { + "description": "The current billable public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getCurrentBillableBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getCurrentBillableBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDatacenter": { + "get": { + "description": "Information regarding the datacenter in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDatacenter/", + "operationId": "SoftLayer_Hardware_Server::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDatacenterName": { + "get": { + "description": "The name of the datacenter in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDatacenterName/", + "operationId": "SoftLayer_Hardware_Server::getDatacenterName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDaysInSparePool": { + "get": { + "description": "Number of day(s) a server have been in spare pool.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDaysInSparePool/", + "operationId": "SoftLayer_Hardware_Server::getDaysInSparePool", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownlinkHardware": { + "get": { + "description": "All hardware that has uplink network connections to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDownlinkHardware/", + "operationId": "SoftLayer_Hardware_Server::getDownlinkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownlinkNetworkHardware": { + "get": { + "description": "All hardware that has uplink network connections to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDownlinkNetworkHardware/", + "operationId": "SoftLayer_Hardware_Server::getDownlinkNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownlinkServers": { + "get": { + "description": "Information regarding all servers attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDownlinkServers/", + "operationId": "SoftLayer_Hardware_Server::getDownlinkServers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownlinkVirtualGuests": { + "get": { + "description": "Information regarding all virtual guests attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDownlinkVirtualGuests/", + "operationId": "SoftLayer_Hardware_Server::getDownlinkVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownstreamHardwareBindings": { + "get": { + "description": "All hardware downstream from a network device.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDownstreamHardwareBindings/", + "operationId": "SoftLayer_Hardware_Server::getDownstreamHardwareBindings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Uplink_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownstreamNetworkHardware": { + "get": { + "description": "All network hardware downstream from the selected piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardware/", + "operationId": "SoftLayer_Hardware_Server::getDownstreamNetworkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownstreamNetworkHardwareWithIncidents": { + "get": { + "description": "All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardwareWithIncidents/", + "operationId": "SoftLayer_Hardware_Server::getDownstreamNetworkHardwareWithIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownstreamServers": { + "get": { + "description": "Information regarding all servers attached downstream to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDownstreamServers/", + "operationId": "SoftLayer_Hardware_Server::getDownstreamServers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownstreamVirtualGuests": { + "get": { + "description": "Information regarding all virtual guests attached to a piece of network hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDownstreamVirtualGuests/", + "operationId": "SoftLayer_Hardware_Server::getDownstreamVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDriveControllers": { + "get": { + "description": "The drive controllers contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getDriveControllers/", + "operationId": "SoftLayer_Hardware_Server::getDriveControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getEvaultNetworkStorage": { + "get": { + "description": "Information regarding a piece of hardware's associated EVault network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getEvaultNetworkStorage/", + "operationId": "SoftLayer_Hardware_Server::getEvaultNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getFirewallServiceComponent": { + "get": { + "description": "Information regarding a piece of hardware's firewall services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getFirewallServiceComponent/", + "operationId": "SoftLayer_Hardware_Server::getFirewallServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getFixedConfigurationPreset": { + "get": { + "description": "Defines the fixed components in a fixed configuration bare metal server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getFixedConfigurationPreset/", + "operationId": "SoftLayer_Hardware_Server::getFixedConfigurationPreset", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getFrontendNetworkComponents": { + "get": { + "description": "A piece of hardware's front-end or public network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getFrontendNetworkComponents/", + "operationId": "SoftLayer_Hardware_Server::getFrontendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getFrontendRouters": { + "get": { + "description": "A hardware's frontend or public router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getFrontendRouters/", + "operationId": "SoftLayer_Hardware_Server::getFrontendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getFutureBillingItem": { + "get": { + "description": "Information regarding the future billing item for a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getFutureBillingItem/", + "operationId": "SoftLayer_Hardware_Server::getFutureBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getGlobalIdentifier": { + "get": { + "description": "A hardware's universally unique identifier.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getGlobalIdentifier/", + "operationId": "SoftLayer_Hardware_Server::getGlobalIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHardDrives": { + "get": { + "description": "The hard drives contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHardDrives/", + "operationId": "SoftLayer_Hardware_Server::getHardDrives", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHardwareChassis": { + "get": { + "description": "The chassis that a piece of hardware is housed in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHardwareChassis/", + "operationId": "SoftLayer_Hardware_Server::getHardwareChassis", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Chassis" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHardwareFunction": { + "get": { + "description": "A hardware's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHardwareFunction/", + "operationId": "SoftLayer_Hardware_Server::getHardwareFunction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Function" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHardwareFunctionDescription": { + "get": { + "description": "A hardware's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHardwareFunctionDescription/", + "operationId": "SoftLayer_Hardware_Server::getHardwareFunctionDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHardwareState": { + "get": { + "description": "A hardware's power/transaction state.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHardwareState/", + "operationId": "SoftLayer_Hardware_Server::getHardwareState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHardwareStatus": { + "get": { + "description": "A hardware's status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHardwareStatus/", + "operationId": "SoftLayer_Hardware_Server::getHardwareStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHasTrustedPlatformModuleBillingItemFlag": { + "get": { + "description": "Determine in hardware object has TPM enabled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHasTrustedPlatformModuleBillingItemFlag/", + "operationId": "SoftLayer_Hardware_Server::getHasTrustedPlatformModuleBillingItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHostIpsSoftwareComponent": { + "get": { + "description": "Information regarding a host IPS software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHostIpsSoftwareComponent/", + "operationId": "SoftLayer_Hardware_Server::getHostIpsSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getHourlyBillingFlag": { + "get": { + "description": "A server's hourly billing status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getHourlyBillingFlag/", + "operationId": "SoftLayer_Hardware_Server::getHourlyBillingFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getInboundBandwidthUsage": { + "get": { + "description": "The sum of all the inbound network traffic data for the last 30 days.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getInboundBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getInboundBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getInboundPublicBandwidthUsage": { + "get": { + "description": "The total public inbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getInboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getInboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getIsBillingTermChangeAvailableFlag": { + "get": { + "description": "Whether or not this hardware object is eligible to change to term billing.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getIsBillingTermChangeAvailableFlag/", + "operationId": "SoftLayer_Hardware_Server::getIsBillingTermChangeAvailableFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getIsCloudReadyNodeCertified": { + "get": { + "description": "Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getIsCloudReadyNodeCertified/", + "operationId": "SoftLayer_Hardware_Server::getIsCloudReadyNodeCertified", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getLastTransaction": { + "get": { + "description": "Information regarding the last transaction a server performed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getLastTransaction/", + "operationId": "SoftLayer_Hardware_Server::getLastTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getLatestNetworkMonitorIncident": { + "get": { + "description": "A piece of hardware's latest network monitoring incident.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getLatestNetworkMonitorIncident/", + "operationId": "SoftLayer_Hardware_Server::getLatestNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getLocation": { + "get": { + "description": "Where a piece of hardware is located within SoftLayer's location hierarchy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getLocation/", + "operationId": "SoftLayer_Hardware_Server::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getLocationPathString": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getLocationPathString/", + "operationId": "SoftLayer_Hardware_Server::getLocationPathString", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getLockboxNetworkStorage": { + "get": { + "description": "Information regarding a lockbox account associated with a server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getLockboxNetworkStorage/", + "operationId": "SoftLayer_Hardware_Server::getLockboxNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getManagedResourceFlag": { + "get": { + "description": "A flag indicating that the hardware is a managed resource.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getManagedResourceFlag/", + "operationId": "SoftLayer_Hardware_Server::getManagedResourceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getMemory": { + "get": { + "description": "Information regarding a piece of hardware's memory.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getMemory/", + "operationId": "SoftLayer_Hardware_Server::getMemory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getMemoryCapacity": { + "get": { + "description": "The amount of memory a piece of hardware has, measured in gigabytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getMemoryCapacity/", + "operationId": "SoftLayer_Hardware_Server::getMemoryCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getMetricTrackingObject": { + "get": { + "description": "A piece of hardware's metric tracking object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObject/", + "operationId": "SoftLayer_Hardware_Server::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getModules": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getModules/", + "operationId": "SoftLayer_Hardware_Server::getModules", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getMonitoringRobot": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getMonitoringRobot/", + "operationId": "SoftLayer_Hardware_Server::getMonitoringRobot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Monitoring_Robot" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getMonitoringServiceComponent": { + "get": { + "description": "Information regarding a piece of hardware's network monitoring services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceComponent/", + "operationId": "SoftLayer_Hardware_Server::getMonitoringServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getMonitoringServiceEligibilityFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceEligibilityFlag/", + "operationId": "SoftLayer_Hardware_Server::getMonitoringServiceEligibilityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getMotherboard": { + "get": { + "description": "Information regarding a piece of hardware's motherboard.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getMotherboard/", + "operationId": "SoftLayer_Hardware_Server::getMotherboard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkCards": { + "get": { + "description": "Information regarding a piece of hardware's network cards.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkCards/", + "operationId": "SoftLayer_Hardware_Server::getNetworkCards", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkComponents": { + "get": { + "description": "Returns a hardware's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkComponents/", + "operationId": "SoftLayer_Hardware_Server::getNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkGatewayMember": { + "get": { + "description": "The gateway member if this device is part of a network gateway.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMember/", + "operationId": "SoftLayer_Hardware_Server::getNetworkGatewayMember", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Member" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkGatewayMemberFlag": { + "get": { + "description": "Whether or not this device is part of a network gateway.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMemberFlag/", + "operationId": "SoftLayer_Hardware_Server::getNetworkGatewayMemberFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkManagementIpAddress": { + "get": { + "description": "A piece of hardware's network management IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkManagementIpAddress/", + "operationId": "SoftLayer_Hardware_Server::getNetworkManagementIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkMonitorAttachedDownHardware": { + "get": { + "description": "All servers with failed monitoring that are attached downstream to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownHardware/", + "operationId": "SoftLayer_Hardware_Server::getNetworkMonitorAttachedDownHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkMonitorAttachedDownVirtualGuests": { + "get": { + "description": "Virtual guests that are attached downstream to a hardware that have failed monitoring", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownVirtualGuests/", + "operationId": "SoftLayer_Hardware_Server::getNetworkMonitorAttachedDownVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkMonitorIncidents": { + "get": { + "description": "The status of all of a piece of hardware's network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorIncidents/", + "operationId": "SoftLayer_Hardware_Server::getNetworkMonitorIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkMonitors": { + "get": { + "description": "Information regarding a piece of hardware's network monitors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkMonitors/", + "operationId": "SoftLayer_Hardware_Server::getNetworkMonitors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkStatus": { + "get": { + "description": "The value of a hardware's network status attribute. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkStatus/", + "operationId": "SoftLayer_Hardware_Server::getNetworkStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkStatusAttribute": { + "get": { + "description": "The hardware's related network status attribute. [DEPRECATED]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkStatusAttribute/", + "operationId": "SoftLayer_Hardware_Server::getNetworkStatusAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkStorage": { + "get": { + "description": "Information regarding a piece of hardware's associated network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkStorage/", + "operationId": "SoftLayer_Hardware_Server::getNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkVlans": { + "get": { + "description": "The network virtual LANs (VLANs) associated with a piece of hardware's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNetworkVlans/", + "operationId": "SoftLayer_Hardware_Server::getNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNextBillingCycleBandwidthAllocation": { + "get": { + "description": "A hardware's allotted bandwidth for the next billing cycle (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNextBillingCycleBandwidthAllocation/", + "operationId": "SoftLayer_Hardware_Server::getNextBillingCycleBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNotesHistory": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNotesHistory/", + "operationId": "SoftLayer_Hardware_Server::getNotesHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Note" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNvRamCapacity": { + "get": { + "description": "The amount of non-volatile memory a piece of hardware has, measured in gigabytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNvRamCapacity/", + "operationId": "SoftLayer_Hardware_Server::getNvRamCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNvRamComponentModels": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getNvRamComponentModels/", + "operationId": "SoftLayer_Hardware_Server::getNvRamComponentModels", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getOperatingSystem": { + "get": { + "description": "Information regarding a piece of hardware's operating system.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getOperatingSystem/", + "operationId": "SoftLayer_Hardware_Server::getOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_OperatingSystem" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getOperatingSystemReferenceCode": { + "get": { + "description": "A hardware's operating system software description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getOperatingSystemReferenceCode/", + "operationId": "SoftLayer_Hardware_Server::getOperatingSystemReferenceCode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getOutboundBandwidthUsage": { + "get": { + "description": "The sum of all the outbound network traffic data for the last 30 days.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getOutboundBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getOutboundBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getOutboundPublicBandwidthUsage": { + "get": { + "description": "The total public outbound bandwidth for this hardware for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getOutboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Hardware_Server::getOutboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getParentBay": { + "get": { + "description": "Blade Bay", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getParentBay/", + "operationId": "SoftLayer_Hardware_Server::getParentBay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Blade" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getParentHardware": { + "get": { + "description": "Parent Hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getParentHardware/", + "operationId": "SoftLayer_Hardware_Server::getParentHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPointOfPresenceLocation": { + "get": { + "description": "Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPointOfPresenceLocation/", + "operationId": "SoftLayer_Hardware_Server::getPointOfPresenceLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPowerComponents": { + "get": { + "description": "The power components for a hardware object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPowerComponents/", + "operationId": "SoftLayer_Hardware_Server::getPowerComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Power_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPowerSupply": { + "get": { + "description": "Information regarding a piece of hardware's power supply.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPowerSupply/", + "operationId": "SoftLayer_Hardware_Server::getPowerSupply", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrimaryBackendIpAddress": { + "get": { + "description": "The hardware's primary private IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendIpAddress/", + "operationId": "SoftLayer_Hardware_Server::getPrimaryBackendIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrimaryBackendNetworkComponent": { + "get": { + "description": "Information regarding the hardware's primary back-end network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendNetworkComponent/", + "operationId": "SoftLayer_Hardware_Server::getPrimaryBackendNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrimaryIpAddress": { + "get": { + "description": "The hardware's primary public IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrimaryIpAddress/", + "operationId": "SoftLayer_Hardware_Server::getPrimaryIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrimaryNetworkComponent": { + "get": { + "description": "Information regarding the hardware's primary public network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrimaryNetworkComponent/", + "operationId": "SoftLayer_Hardware_Server::getPrimaryNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateNetworkOnlyFlag": { + "get": { + "description": "Whether the hardware only has access to the private network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkOnlyFlag/", + "operationId": "SoftLayer_Hardware_Server::getPrivateNetworkOnlyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getProcessorCoreAmount": { + "get": { + "description": "The total number of processor cores, summed from all processors that are attached to a piece of hardware", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getProcessorCoreAmount/", + "operationId": "SoftLayer_Hardware_Server::getProcessorCoreAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getProcessorPhysicalCoreAmount": { + "get": { + "description": "The total number of physical processor cores, summed from all processors that are attached to a piece of hardware", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getProcessorPhysicalCoreAmount/", + "operationId": "SoftLayer_Hardware_Server::getProcessorPhysicalCoreAmount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getProcessors": { + "get": { + "description": "Information regarding a piece of hardware's processors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getProcessors/", + "operationId": "SoftLayer_Hardware_Server::getProcessors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRack": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRack/", + "operationId": "SoftLayer_Hardware_Server::getRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRaidControllers": { + "get": { + "description": "The RAID controllers contained within a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRaidControllers/", + "operationId": "SoftLayer_Hardware_Server::getRaidControllers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRecentEvents": { + "get": { + "description": "Recent events that impact this hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRecentEvents/", + "operationId": "SoftLayer_Hardware_Server::getRecentEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRemoteManagementAccounts": { + "get": { + "description": "User credentials to issue commands and/or interact with the server's remote management card.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRemoteManagementAccounts/", + "operationId": "SoftLayer_Hardware_Server::getRemoteManagementAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_RemoteManagement_User" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRemoteManagementComponent": { + "get": { + "description": "A hardware's associated remote management component. This is normally IPMI.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRemoteManagementComponent/", + "operationId": "SoftLayer_Hardware_Server::getRemoteManagementComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getResourceConfigurations": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getResourceConfigurations/", + "operationId": "SoftLayer_Hardware_Server::getResourceConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Resource_Configuration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getResourceGroupMemberReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getResourceGroupMemberReferences/", + "operationId": "SoftLayer_Hardware_Server::getResourceGroupMemberReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group_Member" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getResourceGroupRoles": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getResourceGroupRoles/", + "operationId": "SoftLayer_Hardware_Server::getResourceGroupRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group_Role" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getResourceGroups": { + "get": { + "description": "The resource groups in which this hardware is a member.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getResourceGroups/", + "operationId": "SoftLayer_Hardware_Server::getResourceGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Resource_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getRouters": { + "get": { + "description": "A hardware's routers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getRouters/", + "operationId": "SoftLayer_Hardware_Server::getRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getSecurityScanRequests": { + "get": { + "description": "Information regarding a piece of hardware's vulnerability scan requests.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getSecurityScanRequests/", + "operationId": "SoftLayer_Hardware_Server::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_Hardware_Server/{SoftLayer_Hardware_ServerID}/getServerRoom": { + "get": { + "description": "Information regarding the server room in which the hardware is located.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getServerRoom/", + "operationId": "SoftLayer_Hardware_Server::getServerRoom", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getServiceProvider": { + "get": { + "description": "Information regarding the piece of hardware's service provider.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getServiceProvider/", + "operationId": "SoftLayer_Hardware_Server::getServiceProvider", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Service_Provider" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getSoftwareComponents": { + "get": { + "description": "Information regarding a piece of hardware's installed software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getSoftwareComponents/", + "operationId": "SoftLayer_Hardware_Server::getSoftwareComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getSparePoolBillingItem": { + "get": { + "description": "Information regarding the billing item for a spare pool server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getSparePoolBillingItem/", + "operationId": "SoftLayer_Hardware_Server::getSparePoolBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getSshKeys": { + "get": { + "description": "SSH keys to be installed on the server during provisioning or an OS reload.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getSshKeys/", + "operationId": "SoftLayer_Hardware_Server::getSshKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getStorageGroups": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getStorageGroups/", + "operationId": "SoftLayer_Hardware_Server::getStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getStorageNetworkComponents": { + "get": { + "description": "A piece of hardware's private storage network components. [Deprecated]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getStorageNetworkComponents/", + "operationId": "SoftLayer_Hardware_Server::getStorageNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getTagReferences/", + "operationId": "SoftLayer_Hardware_Server::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getTopLevelLocation": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getTopLevelLocation/", + "operationId": "SoftLayer_Hardware_Server::getTopLevelLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getUpgradeRequest": { + "get": { + "description": "An account's associated upgrade request object, if any.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getUpgradeRequest/", + "operationId": "SoftLayer_Hardware_Server::getUpgradeRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Upgrade_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getUpgradeableActiveComponents": { + "get": { + "description": "A piece of hardware's active upgradeable physical components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getUpgradeableActiveComponents/", + "operationId": "SoftLayer_Hardware_Server::getUpgradeableActiveComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getUplinkHardware": { + "get": { + "description": "The network device connected to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getUplinkHardware/", + "operationId": "SoftLayer_Hardware_Server::getUplinkHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getUplinkNetworkComponents": { + "get": { + "description": "Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getUplinkNetworkComponents/", + "operationId": "SoftLayer_Hardware_Server::getUplinkNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getUserData": { + "get": { + "description": "An array containing a single string of custom user data for a hardware order. Max size is 16 kb.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getUserData/", + "operationId": "SoftLayer_Hardware_Server::getUserData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getVirtualChassis": { + "get": { + "description": "Information regarding the virtual chassis for a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getVirtualChassis/", + "operationId": "SoftLayer_Hardware_Server::getVirtualChassis", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getVirtualChassisSiblings": { + "get": { + "description": "Information regarding the virtual chassis siblings for a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getVirtualChassisSiblings/", + "operationId": "SoftLayer_Hardware_Server::getVirtualChassisSiblings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getVirtualHost": { + "get": { + "description": "A piece of hardware's virtual host record.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getVirtualHost/", + "operationId": "SoftLayer_Hardware_Server::getVirtualHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getVirtualLicenses": { + "get": { + "description": "Information regarding a piece of hardware's virtual software licenses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getVirtualLicenses/", + "operationId": "SoftLayer_Hardware_Server::getVirtualLicenses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_VirtualLicense" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getVirtualRack": { + "get": { + "description": "Information regarding the bandwidth allotment to which a piece of hardware belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getVirtualRack/", + "operationId": "SoftLayer_Hardware_Server::getVirtualRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getVirtualRackId": { + "get": { + "description": "The name of the bandwidth allotment belonging to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getVirtualRackId/", + "operationId": "SoftLayer_Hardware_Server::getVirtualRackId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getVirtualRackName": { + "get": { + "description": "The name of the bandwidth allotment belonging to a piece of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getVirtualRackName/", + "operationId": "SoftLayer_Hardware_Server::getVirtualRackName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getVirtualizationPlatform": { + "get": { + "description": "A piece of hardware's virtualization platform software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/getVirtualizationPlatform/", + "operationId": "SoftLayer_Hardware_Server::getVirtualizationPlatform", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Container/getAllObjects": { + "get": { + "description": "Use this method to retrieve all active layout containers that can be customized. ", + "summary": "Returns customizable layout containers", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Container/getAllObjects/", + "operationId": "SoftLayer_Layout_Container::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Container" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Container/{SoftLayer_Layout_ContainerID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Layout_Container record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Container/getObject/", + "operationId": "SoftLayer_Layout_Container::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Container" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Container/{SoftLayer_Layout_ContainerID}/getLayoutContainerType": { + "get": { + "description": "The type of the layout container object", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Container/getLayoutContainerType/", + "operationId": "SoftLayer_Layout_Container::getLayoutContainerType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Container_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Container/{SoftLayer_Layout_ContainerID}/getLayoutItems": { + "get": { + "description": "The layout items assigned to this layout container", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Container/getLayoutItems/", + "operationId": "SoftLayer_Layout_Container::getLayoutItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Item/{SoftLayer_Layout_ItemID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Layout_Item record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Item/getObject/", + "operationId": "SoftLayer_Layout_Item::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Item/{SoftLayer_Layout_ItemID}/getLayoutItemPreferences": { + "get": { + "description": "The layout preferences assigned to this layout item", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Item/getLayoutItemPreferences/", + "operationId": "SoftLayer_Layout_Item::getLayoutItemPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Item/{SoftLayer_Layout_ItemID}/getLayoutItemType": { + "get": { + "description": "The type of the layout item object", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Item/getLayoutItemType/", + "operationId": "SoftLayer_Layout_Item::getLayoutItemType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Item_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile/createObject": { + "post": { + "description": "This method creates a new layout profile object. ", + "summary": "Create a new layout profile", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile/createObject/", + "operationId": "SoftLayer_Layout_Profile::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile/{SoftLayer_Layout_ProfileID}/deleteObject": { + "get": { + "description": "This method deletes an existing layout profile and associated custom preferences ", + "summary": "Delete a layout profile", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile/deleteObject/", + "operationId": "SoftLayer_Layout_Profile::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile/{SoftLayer_Layout_ProfileID}/editObject": { + "post": { + "description": "This method edits an existing layout profile object by passing in a modified instance of the object. ", + "summary": "Edit the layout profile object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile/editObject/", + "operationId": "SoftLayer_Layout_Profile::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile/{SoftLayer_Layout_ProfileID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Layout_Profile record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile/getObject/", + "operationId": "SoftLayer_Layout_Profile::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile/{SoftLayer_Layout_ProfileID}/modifyPreference": { + "post": { + "description": "This method modifies an existing associated [[SoftLayer_Layout_Profile_Preference]] object. If the preference object being modified is a default value object, a new record is created to override the default value. \n\nOnly preferences that are assigned to a profile may be updated. Attempts to update a non-existent preference object will result in an exception being thrown. ", + "summary": "Modifies an associated layout preference", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile/modifyPreference/", + "operationId": "SoftLayer_Layout_Profile::modifyPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile_Preference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile/{SoftLayer_Layout_ProfileID}/modifyPreferences": { + "post": { + "description": "Using this method, multiple [[SoftLayer_Layout_Profile_Preference]] objects may be updated at once. \n\nRefer to [[SoftLayer_Layout_Profile::modifyPreference()]] for more information. ", + "summary": "Modifies a collection of associated preferences", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile/modifyPreferences/", + "operationId": "SoftLayer_Layout_Profile::modifyPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile/{SoftLayer_Layout_ProfileID}/getLayoutContainers": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile/getLayoutContainers/", + "operationId": "SoftLayer_Layout_Profile::getLayoutContainers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Container" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile/{SoftLayer_Layout_ProfileID}/getLayoutPreferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile/getLayoutPreferences/", + "operationId": "SoftLayer_Layout_Profile::getLayoutPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Containers/createObject": { + "post": { + "description": null, + "summary": "Associate a layout container with a profile", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Containers/createObject/", + "operationId": "SoftLayer_Layout_Profile_Containers::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile_Containers" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Containers/{SoftLayer_Layout_Profile_ContainersID}/editObject": { + "post": { + "description": null, + "summary": "Edit the object by passing in a modified instance of the object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Containers/editObject/", + "operationId": "SoftLayer_Layout_Profile_Containers::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Containers/{SoftLayer_Layout_Profile_ContainersID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Layout_Profile_Containers record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Containers/getObject/", + "operationId": "SoftLayer_Layout_Profile_Containers::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile_Containers" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Containers/{SoftLayer_Layout_Profile_ContainersID}/getLayoutContainerType": { + "get": { + "description": "The container to be contained", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutContainerType/", + "operationId": "SoftLayer_Layout_Profile_Containers::getLayoutContainerType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Container" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Containers/{SoftLayer_Layout_Profile_ContainersID}/getLayoutProfile": { + "get": { + "description": "The profile containing this container", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutProfile/", + "operationId": "SoftLayer_Layout_Profile_Containers::getLayoutProfile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Customer/{SoftLayer_Layout_Profile_CustomerID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Layout_Profile_Customer record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Customer/getObject/", + "operationId": "SoftLayer_Layout_Profile_Customer::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Customer/createObject": { + "post": { + "description": "This method creates a new layout profile object. ", + "summary": "Create a new layout profile", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Customer/createObject/", + "operationId": "SoftLayer_Layout_Profile_Customer::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Customer/{SoftLayer_Layout_Profile_CustomerID}/deleteObject": { + "get": { + "description": "This method deletes an existing layout profile and associated custom preferences ", + "summary": "Delete a layout profile", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Customer/deleteObject/", + "operationId": "SoftLayer_Layout_Profile_Customer::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Customer/{SoftLayer_Layout_Profile_CustomerID}/editObject": { + "post": { + "description": "This method edits an existing layout profile object by passing in a modified instance of the object. ", + "summary": "Edit the layout profile object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Customer/editObject/", + "operationId": "SoftLayer_Layout_Profile_Customer::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Customer/{SoftLayer_Layout_Profile_CustomerID}/modifyPreference": { + "post": { + "description": "This method modifies an existing associated [[SoftLayer_Layout_Profile_Preference]] object. If the preference object being modified is a default value object, a new record is created to override the default value. \n\nOnly preferences that are assigned to a profile may be updated. Attempts to update a non-existent preference object will result in an exception being thrown. ", + "summary": "Modifies an associated layout preference", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreference/", + "operationId": "SoftLayer_Layout_Profile_Customer::modifyPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile_Preference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Customer/{SoftLayer_Layout_Profile_CustomerID}/modifyPreferences": { + "post": { + "description": "Using this method, multiple [[SoftLayer_Layout_Profile_Preference]] objects may be updated at once. \n\nRefer to [[SoftLayer_Layout_Profile::modifyPreference()]] for more information. ", + "summary": "Modifies a collection of associated preferences", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreferences/", + "operationId": "SoftLayer_Layout_Profile_Customer::modifyPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Customer/{SoftLayer_Layout_Profile_CustomerID}/getUserRecord": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Customer/getUserRecord/", + "operationId": "SoftLayer_Layout_Profile_Customer::getUserRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Customer/{SoftLayer_Layout_Profile_CustomerID}/getLayoutContainers": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutContainers/", + "operationId": "SoftLayer_Layout_Profile_Customer::getLayoutContainers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Container" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Customer/{SoftLayer_Layout_Profile_CustomerID}/getLayoutPreferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutPreferences/", + "operationId": "SoftLayer_Layout_Profile_Customer::getLayoutPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Preference/{SoftLayer_Layout_Profile_PreferenceID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Layout_Profile_Preference record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Preference/getObject/", + "operationId": "SoftLayer_Layout_Profile_Preference::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile_Preference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Preference/{SoftLayer_Layout_Profile_PreferenceID}/getLayoutContainer": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutContainer/", + "operationId": "SoftLayer_Layout_Profile_Preference::getLayoutContainer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Container" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Preference/{SoftLayer_Layout_Profile_PreferenceID}/getLayoutItem": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutItem/", + "operationId": "SoftLayer_Layout_Profile_Preference::getLayoutItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Preference/{SoftLayer_Layout_Profile_PreferenceID}/getLayoutPreference": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutPreference/", + "operationId": "SoftLayer_Layout_Profile_Preference::getLayoutPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Preference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Layout_Profile_Preference/{SoftLayer_Layout_Profile_PreferenceID}/getLayoutProfile": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutProfile/", + "operationId": "SoftLayer_Layout_Profile_Preference::getLayoutProfile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale/getClosestToLanguageTag": { + "post": { + "description": null, + "summary": "Get the closest locale for the language tag (ISO 639-1 & 3166-1) format.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale/getClosestToLanguageTag/", + "operationId": "SoftLayer_Locale::getClosestToLanguageTag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale/{SoftLayer_LocaleID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Locale record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale/getObject/", + "operationId": "SoftLayer_Locale::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Country/getAllVatCountryCodesAndVatIdRegexes": { + "get": { + "description": "This method is to get the collection of VAT country codes and VAT ID Regexes. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Country/getAllVatCountryCodesAndVatIdRegexes/", + "operationId": "SoftLayer_Locale_Country::getAllVatCountryCodesAndVatIdRegexes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Collection_Locale_VatCountryCodeAndFormat" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Country/getAvailableCountries": { + "get": { + "description": "Use this method to retrieve a list of countries and locale information available to the current user. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Country/getAvailableCountries/", + "operationId": "SoftLayer_Locale_Country::getAvailableCountries", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Locale_Country" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Country/getCountries": { + "get": { + "description": "Use this method to retrieve a list of countries and locale information such as country code and state/provinces. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Country/getCountries/", + "operationId": "SoftLayer_Locale_Country::getCountries", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Locale_Country" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Country/getCountriesAndStates": { + "post": { + "description": "This method will return a collection of [[SoftLayer_Container_Collection_Locale_CountryCode]] objects. If the country has states, a [[SoftLayer_Container_Collection_Locale_StateCode]] collection will be provided with the country. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Country/getCountriesAndStates/", + "operationId": "SoftLayer_Locale_Country::getCountriesAndStates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Collection_Locale_CountryCode" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Country/{SoftLayer_Locale_CountryID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Locale_Country record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Country/getObject/", + "operationId": "SoftLayer_Locale_Country::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale_Country" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Country/getPostalCodeRequiredCountryCodes": { + "get": { + "description": "This method will return an array of country codes that require postal code ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Country/getPostalCodeRequiredCountryCodes/", + "operationId": "SoftLayer_Locale_Country::getPostalCodeRequiredCountryCodes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Country/getVatCountries": { + "get": { + "description": "This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID. Note the difference between [[SoftLayer_Locale_Country/getVatRequiredCountryCodes]] - this method will provide all country codes that use VAT ID, including those which are required. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Country/getVatCountries/", + "operationId": "SoftLayer_Locale_Country::getVatCountries", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Country/getVatRequiredCountryCodes": { + "get": { + "description": "This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID. Note the difference between [[SoftLayer_Locale_Country/getVatCountries]] - this method will provide country codes where a VAT ID is required for onboarding to IBM Cloud. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Country/getVatRequiredCountryCodes/", + "operationId": "SoftLayer_Locale_Country::getVatRequiredCountryCodes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Country/isEuropeanUnionCountry": { + "post": { + "description": "Returns true if the country code is in the European Union (EU), false otherwise. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Country/isEuropeanUnionCountry/", + "operationId": "SoftLayer_Locale_Country::isEuropeanUnionCountry", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Country/{SoftLayer_Locale_CountryID}/getStates": { + "get": { + "description": "States that belong to this country.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Country/getStates/", + "operationId": "SoftLayer_Locale_Country::getStates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Locale_StateProvince" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Timezone/getAllObjects": { + "get": { + "description": "Retrieve all timezone objects.", + "summary": "Retrieve all timezone objects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Timezone/getAllObjects/", + "operationId": "SoftLayer_Locale_Timezone::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Locale_Timezone" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Locale_Timezone/{SoftLayer_Locale_TimezoneID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Locale_Timezone object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Locale_Timezone service. ", + "summary": "Retrieve a SoftLayer_Locale_Timezone record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Locale_Timezone/getObject/", + "operationId": "SoftLayer_Locale_Timezone::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale_Timezone" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/getAvailableObjectStorageDatacenters": { + "get": { + "description": "Object Storage is only available in select datacenters. This method will return all the datacenters where object storage is available. ", + "summary": "Get the datacenters where object storage is available", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getAvailableObjectStorageDatacenters/", + "operationId": "SoftLayer_Location::getAvailableObjectStorageDatacenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/getDatacenters": { + "get": { + "description": "Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure. ", + "summary": "Retrieve all datacenter locations", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getDatacenters/", + "operationId": "SoftLayer_Location::getDatacenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/getDatacentersWithVirtualImageStoreServiceResourceRecord": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getDatacentersWithVirtualImageStoreServiceResourceRecord/", + "operationId": "SoftLayer_Location::getDatacentersWithVirtualImageStoreServiceResourceRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Location record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getObject/", + "operationId": "SoftLayer_Location::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/getViewableDatacenters": { + "get": { + "description": "Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure. ", + "summary": "Retrieve all datacenter locations", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getViewableDatacenters/", + "operationId": "SoftLayer_Location::getViewableDatacenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/getViewablePopsAndDataCenters": { + "get": { + "description": "Retrieve all viewable pop and datacenter locations. ", + "summary": "Retrieve viewable pops and datacenters in a combined list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getViewablePopsAndDataCenters/", + "operationId": "SoftLayer_Location::getViewablePopsAndDataCenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/getViewablepointOfPresence": { + "get": { + "description": "Retrieve all viewable network locations. ", + "summary": "Retrieve viewable network locations", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getViewablepointOfPresence/", + "operationId": "SoftLayer_Location::getViewablepointOfPresence", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/getpointOfPresence": { + "get": { + "description": "Retrieve all point of presence locations. ", + "summary": "Retrieve all points of presence locations", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getpointOfPresence/", + "operationId": "SoftLayer_Location::getpointOfPresence", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getActivePresaleEvents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getActivePresaleEvents/", + "operationId": "SoftLayer_Location::getActivePresaleEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Sales_Presale_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getBnppCompliantFlag": { + "get": { + "description": "A flag indicating whether or not the datacenter/location is BNPP compliant.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getBnppCompliantFlag/", + "operationId": "SoftLayer_Location::getBnppCompliantFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getEuCompliantFlag": { + "get": { + "description": "A flag indicating whether or not the datacenter/location is EU compliant.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getEuCompliantFlag/", + "operationId": "SoftLayer_Location::getEuCompliantFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getGroups": { + "get": { + "description": "A location can be a member of 1 or more groups. This will show which groups to which a location belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getGroups/", + "operationId": "SoftLayer_Location::getGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getHardwareFirewalls": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getHardwareFirewalls/", + "operationId": "SoftLayer_Location::getHardwareFirewalls", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getLocationAddress": { + "get": { + "description": "A location's physical address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getLocationAddress/", + "operationId": "SoftLayer_Location::getLocationAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getLocationAddresses": { + "get": { + "description": "A location's physical addresses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getLocationAddresses/", + "operationId": "SoftLayer_Location::getLocationAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getLocationReservationMember": { + "get": { + "description": "A location's Dedicated Rack member", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getLocationReservationMember/", + "operationId": "SoftLayer_Location::getLocationReservationMember", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Reservation_Rack_Member" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getLocationStatus": { + "get": { + "description": "The current locations status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getLocationStatus/", + "operationId": "SoftLayer_Location::getLocationStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getMetricTrackingObject": { + "get": { + "description": "[DEPRECATED] - A location's metric tracking object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getMetricTrackingObject/", + "operationId": "SoftLayer_Location::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getNetworkConfigurationAttribute": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getNetworkConfigurationAttribute/", + "operationId": "SoftLayer_Location::getNetworkConfigurationAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getOnlineSslVpnUserCount": { + "get": { + "description": "The total number of users online using SoftLayer's SSL VPN service for a location.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getOnlineSslVpnUserCount/", + "operationId": "SoftLayer_Location::getOnlineSslVpnUserCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getPathString": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getPathString/", + "operationId": "SoftLayer_Location::getPathString", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getPriceGroups": { + "get": { + "description": "A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getPriceGroups/", + "operationId": "SoftLayer_Location::getPriceGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getRegions": { + "get": { + "description": "A location can be a member of 1 or more regions. This will show which regions to which a location belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getRegions/", + "operationId": "SoftLayer_Location::getRegions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Region" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getTimezone": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getTimezone/", + "operationId": "SoftLayer_Location::getTimezone", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale_Timezone" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location/{SoftLayer_LocationID}/getVdrGroup": { + "get": { + "description": "A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location/getVdrGroup/", + "operationId": "SoftLayer_Location::getVdrGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group_Location_CrossReference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Location_Datacenter record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getObject/", + "operationId": "SoftLayer_Location_Datacenter::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Datacenter" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getStatisticsGraphImage": { + "get": { + "description": "Retrieve a graph of a SoftLayer datacenter's last 48 hours of network activity. Statistics graphs show traffic outbound from a datacenter on top and inbound traffic on the bottom followed by a legend of the network services tracked in the graph. getStatisticsGraphImage returns a PNG image of variable width and height depending on the number of services reported in the image. ", + "summary": "Retrieve a graph of a SoftLayer datacenter's last 48 hours of network activity.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getStatisticsGraphImage/", + "operationId": "SoftLayer_Location_Datacenter::getStatisticsGraphImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/getAvailableObjectStorageDatacenters": { + "get": { + "description": "Object Storage is only available in select datacenters. This method will return all the datacenters where object storage is available. ", + "summary": "Get the datacenters where object storage is available", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getAvailableObjectStorageDatacenters/", + "operationId": "SoftLayer_Location_Datacenter::getAvailableObjectStorageDatacenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/getDatacenters": { + "get": { + "description": "Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure. ", + "summary": "Retrieve all datacenter locations", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getDatacenters/", + "operationId": "SoftLayer_Location_Datacenter::getDatacenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/getDatacentersWithVirtualImageStoreServiceResourceRecord": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getDatacentersWithVirtualImageStoreServiceResourceRecord/", + "operationId": "SoftLayer_Location_Datacenter::getDatacentersWithVirtualImageStoreServiceResourceRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/getViewableDatacenters": { + "get": { + "description": "Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure. ", + "summary": "Retrieve all datacenter locations", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getViewableDatacenters/", + "operationId": "SoftLayer_Location_Datacenter::getViewableDatacenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/getViewablePopsAndDataCenters": { + "get": { + "description": "Retrieve all viewable pop and datacenter locations. ", + "summary": "Retrieve viewable pops and datacenters in a combined list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getViewablePopsAndDataCenters/", + "operationId": "SoftLayer_Location_Datacenter::getViewablePopsAndDataCenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/getViewablepointOfPresence": { + "get": { + "description": "Retrieve all viewable network locations. ", + "summary": "Retrieve viewable network locations", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getViewablepointOfPresence/", + "operationId": "SoftLayer_Location_Datacenter::getViewablepointOfPresence", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/getpointOfPresence": { + "get": { + "description": "Retrieve all point of presence locations. ", + "summary": "Retrieve all points of presence locations", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getpointOfPresence/", + "operationId": "SoftLayer_Location_Datacenter::getpointOfPresence", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getActiveItemPresaleEvents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getActiveItemPresaleEvents/", + "operationId": "SoftLayer_Location_Datacenter::getActiveItemPresaleEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Sales_Presale_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getBackendHardwareRouters": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getBackendHardwareRouters/", + "operationId": "SoftLayer_Location_Datacenter::getBackendHardwareRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getBoundSubnets": { + "get": { + "description": "Subnets which are directly bound to one or more routers in a given datacenter, and currently allow routing.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getBoundSubnets/", + "operationId": "SoftLayer_Location_Datacenter::getBoundSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getBrandCountryRestrictions": { + "get": { + "description": "This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getBrandCountryRestrictions/", + "operationId": "SoftLayer_Location_Datacenter::getBrandCountryRestrictions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Brand_Restriction_Location_CustomerCountry" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getFrontendHardwareRouters": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getFrontendHardwareRouters/", + "operationId": "SoftLayer_Location_Datacenter::getFrontendHardwareRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getHardwareRouters": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getHardwareRouters/", + "operationId": "SoftLayer_Location_Datacenter::getHardwareRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getPresaleEvents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getPresaleEvents/", + "operationId": "SoftLayer_Location_Datacenter::getPresaleEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Sales_Presale_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getRegionalGroup": { + "get": { + "description": "The regional group this datacenter belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getRegionalGroup/", + "operationId": "SoftLayer_Location_Datacenter::getRegionalGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group_Regional" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getRegionalInternetRegistry": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getRegionalInternetRegistry/", + "operationId": "SoftLayer_Location_Datacenter::getRegionalInternetRegistry", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Regional_Internet_Registry" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getRoutableBoundSubnets": { + "get": { + "description": "Retrieve all subnets that are eligible to be routed; those which the account has permission to associate with a vlan.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getRoutableBoundSubnets/", + "operationId": "SoftLayer_Location_Datacenter::getRoutableBoundSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getActivePresaleEvents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getActivePresaleEvents/", + "operationId": "SoftLayer_Location_Datacenter::getActivePresaleEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Sales_Presale_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getBnppCompliantFlag": { + "get": { + "description": "A flag indicating whether or not the datacenter/location is BNPP compliant.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getBnppCompliantFlag/", + "operationId": "SoftLayer_Location_Datacenter::getBnppCompliantFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getEuCompliantFlag": { + "get": { + "description": "A flag indicating whether or not the datacenter/location is EU compliant.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getEuCompliantFlag/", + "operationId": "SoftLayer_Location_Datacenter::getEuCompliantFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getGroups": { + "get": { + "description": "A location can be a member of 1 or more groups. This will show which groups to which a location belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getGroups/", + "operationId": "SoftLayer_Location_Datacenter::getGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getHardwareFirewalls": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getHardwareFirewalls/", + "operationId": "SoftLayer_Location_Datacenter::getHardwareFirewalls", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getLocationAddress": { + "get": { + "description": "A location's physical address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getLocationAddress/", + "operationId": "SoftLayer_Location_Datacenter::getLocationAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getLocationAddresses": { + "get": { + "description": "A location's physical addresses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getLocationAddresses/", + "operationId": "SoftLayer_Location_Datacenter::getLocationAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getLocationReservationMember": { + "get": { + "description": "A location's Dedicated Rack member", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getLocationReservationMember/", + "operationId": "SoftLayer_Location_Datacenter::getLocationReservationMember", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Reservation_Rack_Member" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getLocationStatus": { + "get": { + "description": "The current locations status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getLocationStatus/", + "operationId": "SoftLayer_Location_Datacenter::getLocationStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getMetricTrackingObject": { + "get": { + "description": "[DEPRECATED] - A location's metric tracking object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getMetricTrackingObject/", + "operationId": "SoftLayer_Location_Datacenter::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getNetworkConfigurationAttribute": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getNetworkConfigurationAttribute/", + "operationId": "SoftLayer_Location_Datacenter::getNetworkConfigurationAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getOnlineSslVpnUserCount": { + "get": { + "description": "The total number of users online using SoftLayer's SSL VPN service for a location.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getOnlineSslVpnUserCount/", + "operationId": "SoftLayer_Location_Datacenter::getOnlineSslVpnUserCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getPathString": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getPathString/", + "operationId": "SoftLayer_Location_Datacenter::getPathString", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getPriceGroups": { + "get": { + "description": "A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getPriceGroups/", + "operationId": "SoftLayer_Location_Datacenter::getPriceGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getRegions": { + "get": { + "description": "A location can be a member of 1 or more regions. This will show which regions to which a location belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getRegions/", + "operationId": "SoftLayer_Location_Datacenter::getRegions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Region" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getTimezone": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getTimezone/", + "operationId": "SoftLayer_Location_Datacenter::getTimezone", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale_Timezone" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getVdrGroup": { + "get": { + "description": "A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Datacenter/getVdrGroup/", + "operationId": "SoftLayer_Location_Datacenter::getVdrGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group_Location_CrossReference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group/getAllObjects/", + "operationId": "SoftLayer_Location_Group::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group/{SoftLayer_Location_GroupID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Location_Group record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group/getObject/", + "operationId": "SoftLayer_Location_Group::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group/{SoftLayer_Location_GroupID}/getLocationGroupType": { + "get": { + "description": "The type for this location group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group/getLocationGroupType/", + "operationId": "SoftLayer_Location_Group::getLocationGroupType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group/{SoftLayer_Location_GroupID}/getLocations": { + "get": { + "description": "The locations in a group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group/getLocations/", + "operationId": "SoftLayer_Location_Group::getLocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Pricing/getAllObjects": { + "get": { + "description": null, + "summary": "Get all pricing location groups.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Pricing/getAllObjects/", + "operationId": "SoftLayer_Location_Group_Pricing::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Pricing/{SoftLayer_Location_Group_PricingID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Location_Group_Pricing record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Pricing/getObject/", + "operationId": "SoftLayer_Location_Group_Pricing::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group_Pricing" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Pricing/{SoftLayer_Location_Group_PricingID}/getPrices": { + "get": { + "description": "The prices that this pricing location group limits. All of these prices will only be available in the locations defined by this pricing location group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Pricing/getPrices/", + "operationId": "SoftLayer_Location_Group_Pricing::getPrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Pricing/{SoftLayer_Location_Group_PricingID}/getLocationGroupType": { + "get": { + "description": "The type for this location group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Pricing/getLocationGroupType/", + "operationId": "SoftLayer_Location_Group_Pricing::getLocationGroupType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Pricing/{SoftLayer_Location_Group_PricingID}/getLocations": { + "get": { + "description": "The locations in a group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Pricing/getLocations/", + "operationId": "SoftLayer_Location_Group_Pricing::getLocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Regional/getAllObjects": { + "get": { + "description": null, + "summary": "Get all regional groups.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Regional/getAllObjects/", + "operationId": "SoftLayer_Location_Group_Regional::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Regional/{SoftLayer_Location_Group_RegionalID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Location_Group_Regional record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Regional/getObject/", + "operationId": "SoftLayer_Location_Group_Regional::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group_Regional" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Regional/{SoftLayer_Location_Group_RegionalID}/getDatacenters": { + "get": { + "description": "The datacenters in a group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Regional/getDatacenters/", + "operationId": "SoftLayer_Location_Group_Regional::getDatacenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Regional/{SoftLayer_Location_Group_RegionalID}/getPreferredDatacenter": { + "get": { + "description": "The preferred datacenters of a group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Regional/getPreferredDatacenter/", + "operationId": "SoftLayer_Location_Group_Regional::getPreferredDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Datacenter" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Regional/{SoftLayer_Location_Group_RegionalID}/getLocationGroupType": { + "get": { + "description": "The type for this location group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Regional/getLocationGroupType/", + "operationId": "SoftLayer_Location_Group_Regional::getLocationGroupType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Group_Regional/{SoftLayer_Location_Group_RegionalID}/getLocations": { + "get": { + "description": "The locations in a group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Group_Regional/getLocations/", + "operationId": "SoftLayer_Location_Group_Regional::getLocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation/getAccountReservations": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation/getAccountReservations/", + "operationId": "SoftLayer_Location_Reservation::getAccountReservations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Reservation" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation/{SoftLayer_Location_ReservationID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Location_Reservation record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation/getObject/", + "operationId": "SoftLayer_Location_Reservation::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Reservation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation/{SoftLayer_Location_ReservationID}/getAccount": { + "get": { + "description": "The account that a billing item belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation/getAccount/", + "operationId": "SoftLayer_Location_Reservation::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation/{SoftLayer_Location_ReservationID}/getAllotment": { + "get": { + "description": "The bandwidth allotment that the reservation belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation/getAllotment/", + "operationId": "SoftLayer_Location_Reservation::getAllotment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation/{SoftLayer_Location_ReservationID}/getBillingItem": { + "get": { + "description": "The bandwidth allotment that the reservation belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation/getBillingItem/", + "operationId": "SoftLayer_Location_Reservation::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation/{SoftLayer_Location_ReservationID}/getLocation": { + "get": { + "description": "The datacenter location that the reservation belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation/getLocation/", + "operationId": "SoftLayer_Location_Reservation::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation/{SoftLayer_Location_ReservationID}/getLocationReservationRack": { + "get": { + "description": "Rack information for the reservation", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation/getLocationReservationRack/", + "operationId": "SoftLayer_Location_Reservation::getLocationReservationRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Reservation_Rack" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation_Rack/{SoftLayer_Location_Reservation_RackID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Location_Reservation_Rack record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation_Rack/getObject/", + "operationId": "SoftLayer_Location_Reservation_Rack::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Reservation_Rack" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation_Rack/{SoftLayer_Location_Reservation_RackID}/getAllotment": { + "get": { + "description": "The bandwidth allotment that the reservation belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation_Rack/getAllotment/", + "operationId": "SoftLayer_Location_Reservation_Rack::getAllotment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation_Rack/{SoftLayer_Location_Reservation_RackID}/getChildren": { + "get": { + "description": "Members of the rack.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation_Rack/getChildren/", + "operationId": "SoftLayer_Location_Reservation_Rack::getChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location_Reservation_Rack_Member" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation_Rack/{SoftLayer_Location_Reservation_RackID}/getLocation": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation_Rack/getLocation/", + "operationId": "SoftLayer_Location_Reservation_Rack::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation_Rack/{SoftLayer_Location_Reservation_RackID}/getLocationReservation": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation_Rack/getLocationReservation/", + "operationId": "SoftLayer_Location_Reservation_Rack::getLocationReservation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Reservation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation_Rack_Member/{SoftLayer_Location_Reservation_Rack_MemberID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Location_Reservation_Rack_Member record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation_Rack_Member/getObject/", + "operationId": "SoftLayer_Location_Reservation_Rack_Member::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Reservation_Rack_Member" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation_Rack_Member/{SoftLayer_Location_Reservation_Rack_MemberID}/getLocation": { + "get": { + "description": "Location relation for the rack member", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocation/", + "operationId": "SoftLayer_Location_Reservation_Rack_Member::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Location_Reservation_Rack_Member/{SoftLayer_Location_Reservation_Rack_MemberID}/getLocationReservationRack": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocationReservationRack/", + "operationId": "SoftLayer_Location_Reservation_Rack_Member::getLocationReservationRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Reservation_Rack" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getAllObjects/", + "operationId": "SoftLayer_Marketplace_Partner::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/getAllPublishedPartners": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getAllPublishedPartners/", + "operationId": "SoftLayer_Marketplace_Partner::getAllPublishedPartners", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/getFeaturedPartners": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getFeaturedPartners/", + "operationId": "SoftLayer_Marketplace_Partner::getFeaturedPartners", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/{SoftLayer_Marketplace_PartnerID}/getFile": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getFile/", + "operationId": "SoftLayer_Marketplace_Partner::getFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner_File" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/{SoftLayer_Marketplace_PartnerID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Marketplace_Partner record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getObject/", + "operationId": "SoftLayer_Marketplace_Partner::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/getPartnerByUrlIdentifier": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getPartnerByUrlIdentifier/", + "operationId": "SoftLayer_Marketplace_Partner::getPartnerByUrlIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/{SoftLayer_Marketplace_PartnerID}/getAttachments": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getAttachments/", + "operationId": "SoftLayer_Marketplace_Partner::getAttachments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner_Attachment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/{SoftLayer_Marketplace_PartnerID}/getLogoMedium": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getLogoMedium/", + "operationId": "SoftLayer_Marketplace_Partner::getLogoMedium", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner_Attachment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/{SoftLayer_Marketplace_PartnerID}/getLogoMediumTemp": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getLogoMediumTemp/", + "operationId": "SoftLayer_Marketplace_Partner::getLogoMediumTemp", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner_Attachment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/{SoftLayer_Marketplace_PartnerID}/getLogoSmall": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getLogoSmall/", + "operationId": "SoftLayer_Marketplace_Partner::getLogoSmall", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner_Attachment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Marketplace_Partner/{SoftLayer_Marketplace_PartnerID}/getLogoSmallTemp": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Marketplace_Partner/getLogoSmallTemp/", + "operationId": "SoftLayer_Marketplace_Partner::getLogoSmallTemp", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Marketplace_Partner_Attachment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getBandwidthData": { + "post": { + "description": "Retrieve a collection of raw bandwidth data from an individual public or private network tracking object. Raw data is ideal if you with to employ your own traffic storage and graphing systems. ", + "summary": "Retrieve raw bandwidth data from a tracking object.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthData/", + "operationId": "SoftLayer_Metric_Tracking_Object::getBandwidthData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getBandwidthGraph": { + "post": { + "description": "[DEPRECATED] Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ", + "summary": "[DEPRECATED] Retrieve a bandwidth graph.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph/", + "operationId": "SoftLayer_Metric_Tracking_Object::getBandwidthGraph", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getBandwidthTotal": { + "post": { + "description": "Retrieve the total amount of bandwidth recorded by a tracking object within the given date range. This method will only work on SoftLayer_Metric_Tracking_Object for SoftLayer_Hardware objects, and SoftLayer_Virtual_Guest objects. ", + "summary": "Retrieve the total bandwidth used within a given time frame.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthTotal/", + "operationId": "SoftLayer_Metric_Tracking_Object::getBandwidthTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getDetailsForDateRange": { + "post": { + "description": "Retrieve a collection of detailed metric data over a date range. Ideal if you want to employ your own graphing systems. Note not all metrics support this method. Those that do not return null. ", + "summary": "Retrieve metric detail data over a date range.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange/", + "operationId": "SoftLayer_Metric_Tracking_Object::getDetailsForDateRange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Metric_Tracking_Object_Details" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getGraph": { + "post": { + "description": "[DEPRECATED] Retrieve a PNG image of a metric in graph form. ", + "summary": "[DEPRECATED] Retrieve a graph of a virtual hosting platform's per instance use.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object/getGraph/", + "operationId": "SoftLayer_Metric_Tracking_Object::getGraph", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getMetricDataTypes": { + "get": { + "description": "Returns a collection of metric data types that can be retrieved for a metric tracking object. ", + "summary": "Returns valid metric data types for a tracking object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object/getMetricDataTypes/", + "operationId": "SoftLayer_Metric_Tracking_Object::getMetricDataTypes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Metric_Data_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Metric_Tracking_Object object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Metric_Tracking_Object service. You can only tracking objects that are associated with your SoftLayer account or services. ", + "summary": "Retrieve a SoftLayer_Metric_Tracking_Object record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object/getObject/", + "operationId": "SoftLayer_Metric_Tracking_Object::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getSummary": { + "post": { + "description": "Retrieve a metric summary. Ideal if you want to employ your own graphing systems. Note not all metric types contain a summary. These return null. ", + "summary": "Retrieve metric summary.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object/getSummary/", + "operationId": "SoftLayer_Metric_Tracking_Object::getSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Metric_Tracking_Object_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getSummaryData": { + "post": { + "description": "Returns summarized metric data for the date range, metric type and summary period provided. ", + "summary": "Returns the metric data for the date range provided", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object/getSummaryData/", + "operationId": "SoftLayer_Metric_Tracking_Object::getSummaryData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getType": { + "get": { + "description": "The type of data that a tracking object polls.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object/getType/", + "operationId": "SoftLayer_Metric_Tracking_Object::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/{SoftLayer_Metric_Tracking_Object_Bandwidth_SummaryID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Metric_Tracking_Object_Bandwidth_Summary record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/getObject/", + "operationId": "SoftLayer_Metric_Tracking_Object_Bandwidth_Summary::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Monitoring_Robot/{SoftLayer_Monitoring_RobotID}/checkConnection": { + "get": { + "description": "DEPRECATED. Checks if a monitoring robot can communicate with SoftLayer monitoring management system via the private network. \n\nTCP port 48000 - 48002 must be open on your server or your virtual server in order for this test to succeed. ", + "summary": "DEPRECATED. Checks if a monitoring robot can communicate with SoftLayer monitoring management system ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Monitoring_Robot/checkConnection/", + "operationId": "SoftLayer_Monitoring_Robot::checkConnection", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Monitoring_Robot/{SoftLayer_Monitoring_RobotID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Monitoring_Robot record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Monitoring_Robot/getObject/", + "operationId": "SoftLayer_Monitoring_Robot::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Monitoring_Robot" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network/connectPrivateEndpointService": { + "get": { + "description": "Initiate the automated process to establish connectivity granting the account private back-end network access to the services available through IBM Cloud Service Endpoint. Once initiated, the configuration process occurs asynchronously in the background. \n\n\n\n

Responses

\n\nTrue The request to connect was successfully initiated. \n\nFalse The account and Service Endpoint networks are already connected. \n\n\n\n

Exceptions

\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": "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\n

Responses

\n\nTrue The request to disconnect was successfully initiated. \n\nFalse The account and Service Endpoint networks are already disconnected. \n\n\n\n

Exceptions

\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": "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\n

Responses

\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\n

Exceptions

\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": "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\n

Responses

\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\n

Exceptions

\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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getBandwidthDataByDate": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getBillingItem": { + "get": { + "description": "The billing item for a Application Delivery Controller.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getConfigurationHistory": { + "get": { + "description": "Previous configurations for an Application Delivery Controller.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getDatacenter": { + "get": { + "description": "The datacenter that the application delivery controller resides in.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getDescription": { + "get": { + "description": "A brief description of an application delivery controller record.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getManagementIpAddress": { + "get": { + "description": "An application delivery controller's management ip address.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getPrimaryIpAddress": { + "get": { + "description": "An application delivery controller's primary public IP address.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getType": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getVirtualIpAddresses": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_AttributeID}/getHealthCheck": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_AttributeID}/getType": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID}/getAttributes": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID}/getServices": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_CheckID}/getType": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/deleteObject": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/toggleStatus": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getGroupReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getGroups": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getHealthCheck": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getHealthChecks": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getIpAddress": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_ServiceID}/getServiceGroup": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/kickAllConnections": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getRoutingMethod": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getRoutingType": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getServiceReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getServices": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getVirtualServer": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_GroupID}/getVirtualServers": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getIpAddress": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getLoadBalancerHardware": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getVirtualServers": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/deleteObject": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/getRoutingMethod": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/getServiceGroups": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServerID}/getVirtualIpAddress": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getAccount": { + "get": { + "description": "The account associated with this virtual rack.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getApplicationDeliveryControllers": { + "get": { + "description": "The Application Delivery Controller contained within a virtual rack.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBandwidthAllotmentType": { + "get": { + "description": "The bandwidth allotment type of this virtual rack.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBillingItem": { + "get": { + "description": "A virtual rack's billing item.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getHardware": { + "get": { + "description": "The hardware contained within a virtual rack.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getLocationGroup": { + "get": { + "description": "The location group associated with this virtual rack.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getManagedHardware": { + "get": { + "description": "The managed hardware contained within a virtual rack.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getManagedVirtualGuests": { + "get": { + "description": "The managed Virtual Server contained within a virtual rack.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getMetricTrackingObjectId": { + "get": { + "description": "The metric tracking object id for this allotment.", + "summary": "", + "externalDocs": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getServiceProvider": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getVirtualGuests": { + "get": { + "description": "The Virtual Server contained within a virtual rack.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Account/{SoftLayer_Network_CdnMarketplace_AccountID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Account record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Account/{SoftLayer_Network_CdnMarketplace_AccountID}/getAccount": { + "get": { + "description": "SoftLayer account to which the CDN account belongs.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Account/{SoftLayer_Network_CdnMarketplace_AccountID}/getBillingItem": { + "get": { + "description": "An associated parent billing item which is active.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus": { + "post": { + "description": null, + "summary": "This method gets the status of a given purge path. ", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota": { + "get": { + "description": null, + "summary": "This method gets a purge group quota. ", + "externalDocs": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup": { + "post": { + "description": null, + "summary": "This method returns the list of favorite purge groups. ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup": { + "post": { + "description": null, + "summary": "This method returns the list of unsaved purge groups. ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds": { + "post": { + "description": null, + "summary": "This method purges the content from purge groups. ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite": { + "post": { + "description": null, + "summary": "This method removes a purge group from favorite. ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite": { + "post": { + "description": null, + "summary": "This method saves a purge group as favorite. ", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory": { + "post": { + "description": null, + "summary": "This method returns the list of purge group histories ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive": { + "post": { + "description": null, + "summary": "Creates a Time To Live object and inserts it into the database ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping": { + "post": { + "description": null, + "summary": "SOAP API will create a new CDN domain mapping for a particular customer. ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping": { + "post": { + "description": null, + "summary": "SOAP API will delete CDN domain mapping for a particular customer. ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Mapping/{SoftLayer_Network_CdnMarketplace_Configuration_MappingID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId": { + "post": { + "description": null, + "summary": "SOAP API will return the domain mapping based on the uniqueId. ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings": { + "get": { + "description": null, + "summary": "SOAP API will return all domains for a particular customer. ", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping": { + "post": { + "description": null, + "summary": "SOAP API will start CDN domain mapping for a particular customer. ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping": { + "post": { + "description": null, + "summary": "SOAP API will stop CDN mapping for a particular customer. ", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics": { + "post": { + "description": null, + "summary": "Get the amount of edge hits for an individual mapping. ", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics": { + "post": { + "description": null, + "summary": "Get the real time metrics data for the given mapping ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics": { + "post": { + "description": null, + "summary": "Get the total number of predetermined statistics for direct display for the given mapping ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Vendor/{SoftLayer_Network_CdnMarketplace_VendorID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_CdnMarketplace_Vendor record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_CdnMarketplace_Vendor/listVendors": { + "get": { + "description": null, + "summary": "SOAP API will return all CDN vendors available. ", + "externalDocs": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Component record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getDownlinkComponent": { + "get": { + "description": "The network component linking this object to a child device", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getDuplexMode": { + "get": { + "description": "The duplex mode of a network component.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getHardware": { + "get": { + "description": "The hardware that a network component resides in.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getHighAvailabilityFirewallFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getIpAddressBindings": { + "get": { + "description": "The records of all IP addresses bound to a network component.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getIpAddresses": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getMetricTrackingObject": { + "get": { + "description": "The metric tracking object for this network component.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getNetworkComponentFirewall": { + "get": { + "description": "The upstream network component firewall.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getNetworkComponentGroup": { + "get": { + "description": "A network component's associated group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getNetworkVlan": { + "get": { + "description": "The VLAN that a network component's subnet is associated with.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getNetworkVlanTrunks": { + "get": { + "description": "The VLANs that are trunked to this network component.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getPrimaryIpAddressRecord": { + "get": { + "description": "The primary IPv4 Address record for a network component.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getPrimarySubnet": { + "get": { + "description": "The subnet of the primary IP address assigned to this network component.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getPrimaryVersion6IpAddressRecord": { + "get": { + "description": "The primary IPv6 Address record for a network component.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getRouter": { + "get": { + "description": "A network component's routers.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getSubnets": { + "get": { + "description": "A network component's subnets. A subnet is a group of IP addresses", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getUplinkComponent": { + "get": { + "description": "The network component linking this object to parent", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getUplinkDuplexMode": { + "get": { + "description": "The duplex mode of the uplink network component linking to this object", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/hasActiveTransactions": { + "get": { + "description": "Check for active transactions for the shared Firewall. ", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getBillingItem": { + "get": { + "description": "The billing item for a Hardware Firewall (Dedicated).", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getNetworkFirewallUpdateRequest": { + "get": { + "description": "The update requests made for this firewall.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getRules": { + "get": { + "description": "The currently running rule set of this network component firewall.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Component_Firewall/{SoftLayer_Network_Component_FirewallID}/getSubnets": { + "get": { + "description": "The additional subnets linked to this network component firewall.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Customer_Subnet/{SoftLayer_Network_Customer_SubnetID}/getIpAddresses": { + "get": { + "description": "All ip addresses associated with a subnet.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_DirectLink_Location/getAllObjects": { + "get": { + "description": "Return all existing Direct Link location. ", + "summary": "Get all existing Direct Link location. ", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_DirectLink_Location/{SoftLayer_Network_DirectLink_LocationID}/getLocation": { + "get": { + "description": "The location of Direct Link facility.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_DirectLink_Location/{SoftLayer_Network_DirectLink_LocationID}/getProvider": { + "get": { + "description": "The Id of Direct Link provider.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_DirectLink_Location/{SoftLayer_Network_DirectLink_LocationID}/getServiceType": { + "get": { + "description": "The Id of Direct Link service type.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_DirectLink_Provider/{SoftLayer_Network_DirectLink_ProviderID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_DirectLink_Provider record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_DirectLink_ServiceType/{SoftLayer_Network_DirectLink_ServiceTypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_DirectLink_ServiceType record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Firewall_AccessControlList/{SoftLayer_Network_Firewall_AccessControlListID}/getNetworkFirewallUpdateRequests": { + "get": { + "description": "The update requests made for this firewall.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Firewall_AccessControlList/{SoftLayer_Network_Firewall_AccessControlListID}/getNetworkVlan": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Firewall_Interface/{SoftLayer_Network_Firewall_InterfaceID}/getFirewallContextAccessControlLists": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Firewall_Interface/{SoftLayer_Network_Firewall_InterfaceID}/getNetworkVlan": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Firewall_Module_Context_Interface/{SoftLayer_Network_Firewall_Module_Context_InterfaceID}/getFirewallContextAccessControlLists": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Firewall_Module_Context_Interface/{SoftLayer_Network_Firewall_Module_Context_InterfaceID}/getNetworkVlan": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Firewall_Template/{SoftLayer_Network_Firewall_TemplateID}/getRules": { + "get": { + "description": "The rule set that belongs to this firewall rules template.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Firewall_Update_Request/updateRuleNote": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Firewall_Update_Request/{SoftLayer_Network_Firewall_Update_RequestID}/getAuthorizingUser": { + "get": { + "description": "The user that authorized this firewall update request.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Firewall_Update_Request/{SoftLayer_Network_Firewall_Update_RequestID}/getRules": { + "get": { + "description": "The group of rules contained within the update request.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getCapacity": { + "get": { + "description": "Returns the Gbps capacity of the gateway object \n\n", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getManufacturer": { + "post": { + "description": "Returns manufacturer name for a given gateway object. \n\n", + "summary": "manufacturer name", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Gateway record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/isLicenseServerAllowed": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/rename": { + "post": { + "description": "Edit the name of this gateway. \n\n", + "summary": "Edit Gateway Name", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/setGatewayPassword": { + "post": { + "description": "Returns true if password change is successful, false if not successful \n\n", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getAccount": { + "get": { + "description": "The account for this gateway.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getInsideVlans": { + "get": { + "description": "All VLANs trunked to this gateway.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getMembers": { + "get": { + "description": "The members for this gateway.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getNetworkFirewall": { + "get": { + "description": "The firewall associated with this gateway, if any.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getNetworkFirewallFlag": { + "get": { + "description": "Whether or not there is a firewall associated with this gateway.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPrivateIpAddress": { + "get": { + "description": "The private gateway IP address.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPrivateVlan": { + "get": { + "description": "The private VLAN for accessing this gateway.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPublicIpAddress": { + "get": { + "description": "The public gateway IP address.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPublicIpv6Address": { + "get": { + "description": "The public gateway IPv6 address.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getPublicVlan": { + "get": { + "description": "The public VLAN for accessing this gateway.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/getStatus": { + "get": { + "description": "The current status of the gateway.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Gateway_Member record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getAttributes": { + "get": { + "description": "The attributes for this member.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getGatewaySoftwareDescription": { + "get": { + "description": "The gateway software description for the member.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getHardware": { + "get": { + "description": "The device for this member.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getLicenses": { + "get": { + "description": "The gateway licenses for this member.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getNetworkGateway": { + "get": { + "description": "The gateway this member belongs to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getPasswords": { + "get": { + "description": "The gateway passwords for this member.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Member/{SoftLayer_Network_Gateway_MemberID}/getPublicIpAddress": { + "get": { + "description": "The public gateway IP address.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Member_Attribute/{SoftLayer_Network_Gateway_Member_AttributeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Gateway_Member_Attribute record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Member_Attribute/{SoftLayer_Network_Gateway_Member_AttributeID}/getGatewayMember": { + "get": { + "description": "The gateway member has these attributes.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Precheck/{SoftLayer_Network_Gateway_PrecheckID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Gateway_Precheck record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Precheck/osReloadPrecheck": { + "post": { + "description": "Create an OS Reload Network Gateway Precheck transaction. \n\n", + "summary": "OS Reload Gateway Precheck", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Precheck/upgradePrecheck": { + "post": { + "description": "Create a Upgrade Network Gateway Precheck transaction. \n\n", + "summary": "Upgrade Gateway Precheck", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Status/{SoftLayer_Network_Gateway_StatusID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Gateway_Status record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_VersionUpgrade/getAllUpgradesByGatewayId": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_VersionUpgrade/getGwOrdersAllowedLicenses": { + "post": { + "description": "\n\n\n\n", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_VersionUpgrade/{SoftLayer_Network_Gateway_VersionUpgradeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Gateway_VersionUpgrade record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_VersionUpgrade/{SoftLayer_Network_Gateway_VersionUpgradeID}/validateVersionChange": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Vlan/{SoftLayer_Network_Gateway_VlanID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Gateway_Vlan record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Vlan/{SoftLayer_Network_Gateway_VlanID}/getNetworkGateway": { + "get": { + "description": "The gateway this VLAN is attached to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Gateway_Vlan/{SoftLayer_Network_Gateway_VlanID}/getNetworkVlan": { + "get": { + "description": "The network VLAN record.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/allowDeleteConnection": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/createConnection": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/deleteConnection": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/editConnection": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/getAllConnections": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/getBgpIpRange": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/getDirectLinkSpeeds": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/getNetworkZones": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/getPorts": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/rejectApprovalRequests": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/updateConnectionStatus": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getBillingItem": { + "get": { + "description": "The active billing item for a network interconnect.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getDatacenterName": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getPortLabel": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getServiceType": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getVendorName": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Interconnect_Tenant/{SoftLayer_Network_Interconnect_TenantID}/getZoneName": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_HealthMonitor/{SoftLayer_Network_LBaaS_HealthMonitorID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_LBaaS_HealthMonitor record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Member/{SoftLayer_Network_LBaaS_L7MemberID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_LBaaS_L7Member record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Member/updateL7PoolMembers": { + "post": { + "description": "Update L7 members weight and port. ", + "summary": "Update l7 members weight and port", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Policy/{SoftLayer_Network_LBaaS_L7PolicyID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_LBaaS_L7Policy record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Policy/{SoftLayer_Network_LBaaS_L7PolicyID}/getL7Rules": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_LBaaS_L7Pool record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Pool/updateL7Pool": { + "post": { + "description": "Updates an existing L7 pool, L7 health monitor and L7 session affinity. ", + "summary": "updates L7 pools", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/getL7HealthMonitor": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/getL7Members": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/getL7Policies": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Pool/{SoftLayer_Network_LBaaS_L7PoolID}/getL7SessionAffinity": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_L7Rule/{SoftLayer_Network_LBaaS_L7RuleID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_LBaaS_L7Rule record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_Listener/{SoftLayer_Network_LBaaS_ListenerID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_LBaaS_Listener record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_Listener/{SoftLayer_Network_LBaaS_ListenerID}/getDefaultPool": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_Listener/{SoftLayer_Network_LBaaS_ListenerID}/getL7Policies": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/getAllObjects": { + "get": { + "description": "Return all existing load balancers ", + "summary": "Get all existing load balancers. ", + "externalDocs": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancer": { + "post": { + "description": "Get the load balancer object with given uuid. ", + "summary": "Get a specific load balancer. ", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerMemberHealth": { + "post": { + "description": "Return load balancer members health ", + "summary": "Return load balancer members health", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancers": { + "post": { + "description": "Get the load balancer objects for the given user accounts. ", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_LBaaS_LoadBalancer record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/serviceDNS": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/serviceLoadBalancer": { + "post": { + "description": null, + "summary": "Service function for a load balancer. ", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getDatacenter": { + "get": { + "description": "Datacenter, where load balancer is located.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getHealthMonitors": { + "get": { + "description": "Health monitors for the backend members.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getL7Pools": { + "get": { + "description": "L7Pools for load balancer.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getListeners": { + "get": { + "description": "Listeners assigned to load balancer.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getMembers": { + "get": { + "description": "Members assigned to load balancer.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancer/{SoftLayer_Network_LBaaS_LoadBalancerID}/getSslCiphers": { + "get": { + "description": "list of preferred custom ciphers configured for the load balancer.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_LoadBalancerAppliance/{SoftLayer_Network_LBaaS_LoadBalancerApplianceID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_LBaaS_LoadBalancerAppliance record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_Member/{SoftLayer_Network_LBaaS_MemberID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_LBaaS_Member record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LBaaS_SSLCipher/getAllObjects": { + "get": { + "description": "Returns all supported cipher list ", + "summary": "Get all supported ciphers. ", + "externalDocs": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LoadBalancer_Service/{SoftLayer_Network_LoadBalancer_ServiceID}/getVip": { + "get": { + "description": "The load balancer that this service belongs to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/getAccount": { + "get": { + "description": "The account that owns this load balancer.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/getBillingItem": { + "get": { + "description": "The current billing item for the Load Balancer.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/getManagedResourceFlag": { + "get": { + "description": "A flag indicating that the load balancer is a managed resource.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_LoadBalancer_VirtualIpAddressID}/getServices": { + "get": { + "description": "the services on this load balancer.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Message_Delivery record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/getBillingItem": { + "get": { + "description": "The billing item for a network message delivery account.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/getType": { + "get": { + "description": "The message delivery type of a network message delivery account.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery/{SoftLayer_Network_Message_DeliveryID}/getVendor": { + "get": { + "description": "The vendor for a network message delivery account.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/addUnsubscribeEmailAddress": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/deleteEmailListEntries": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/disableSmtpAccess": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/enableSmtpAccess": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getAccountOverview": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getEmailList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getOfferingsList": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getStatistics": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/getStatisticsGraph": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/singleSignOn": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/updateEmailAddress": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Message_Delivery_Email_Sendgrid/{SoftLayer_Network_Message_Delivery_Email_SendgridID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Monitor_Version1_Query_Host/{SoftLayer_Network_Monitor_Version1_Query_HostID}/getResponseAction": { + "get": { + "description": "The action taken when a monitor fails.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getAccount": { + "get": { + "description": "The account associated with a security scan request.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getGuest": { + "get": { + "description": "The virtual guest a security scan is run against.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getHardware": { + "get": { + "description": "The hardware a security scan is run against.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Security_Scanner_Request/{SoftLayer_Network_Security_Scanner_RequestID}/getStatus": { + "get": { + "description": "A security scan request's status.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_SecurityGroup/createObject": { + "post": { + "description": "Create a new security group.", + "summary": "Create a new security group.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_SecurityGroup/createObjects": { + "post": { + "description": "Create new security groups.", + "summary": "Create new security groups.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/editObject": { + "post": { + "description": "Edit a security group.", + "summary": "Edit a security group.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_SecurityGroup/editObjects": { + "post": { + "description": "Edit security groups.", + "summary": "Edit security groups.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_SecurityGroup/getAllObjects": { + "get": { + "description": null, + "summary": "Get all security groups.", + "externalDocs": "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": "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": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/getAccount": { + "get": { + "description": "The account this security group belongs to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/getNetworkComponentBindings": { + "get": { + "description": "The network component bindings for this security group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/getOrderBindings": { + "get": { + "description": "The order bindings for this security group", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_SecurityGroup/{SoftLayer_Network_SecurityGroupID}/getRules": { + "get": { + "description": "The rules for this security group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Service_Vpn_Overrides/createObjects": { + "post": { + "description": "Create Softlayer portal user VPN overrides. ", + "summary": "Create Softlayer portal user VPN overrides.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Service_Vpn_Overrides/{SoftLayer_Network_Service_Vpn_OverridesID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Service_Vpn_Overrides record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Service_Vpn_Overrides/{SoftLayer_Network_Service_Vpn_OverridesID}/getSubnet": { + "get": { + "description": "Subnet components accessible by a SoftLayer VPN portal user.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Service_Vpn_Overrides/{SoftLayer_Network_Service_Vpn_OverridesID}/getUser": { + "get": { + "description": "SoftLayer VPN portal user.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromHardwareList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromIpAddressList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessFromSubnetList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/allowAccessToReplicantFromIpAddress": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/createFolder": { + "post": { + "description": null, + "summary": "Create a new folder in the root directory.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/createSnapshot": { + "post": { + "description": null, + "summary": "Manually create a new snapshot of a storage volume.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/deleteFolder": { + "post": { + "description": null, + "summary": "Delete a folder in the root directory.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getCdnUrls": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getClusterResource": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFileList": { + "post": { + "description": null, + "summary": "Retrieve list of files in a given folder for this account.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFolderList": { + "get": { + "description": null, + "summary": "Retrieve a list of level 1 folders for this account.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getMaximumExpansionSize": { + "get": { + "description": null, + "summary": "Returns the maximum volume expansion size in GB.", + "externalDocs": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getNetworkConnectionDetails": { + "get": { + "description": null, + "summary": "Retrieve network connection details for complex network storage volumes.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getNetworkMountAddress": { + "get": { + "description": null, + "summary": "Displays the mount path of a storage volume.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getNetworkMountPath": { + "get": { + "description": null, + "summary": "Displays the mount path of a storage volume.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/getObjectStorageConnectionInformation": { + "get": { + "description": null, + "summary": "Retrieve all object storage details for connection", + "externalDocs": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicationTimestamp": { + "get": { + "description": null, + "summary": "An API call to fetch the last timestamp of the replication process", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getStorageGroupsNetworkConnectionDetails": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getTargetIpAddresses": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getValidReplicationTargetDatacenterLocations": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/initiateOriginVolumeReclaim": { + "get": { + "description": null, + "summary": "Initiates Origin Volume Reclaim to delete volume from NetApp.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/initiateVolumeCutover": { + "get": { + "description": null, + "summary": "Initiates Volume Cutover to remove access from the old volume.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/isBlockingOperationInProgress": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/isVolumeActive": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/refreshDuplicate": { + "post": { + "description": null, + "summary": "Refreshes any duplicate volume with a snapshot taken from its parent.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromIpAddressList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromSubnet": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessFromSubnetList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/removeAccessToReplicantFromSubnet": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/setSnapshotAllocation": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAccount": { + "get": { + "description": "The account that a Storage services belongs to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAccountPassword": { + "get": { + "description": "Other usernames and passwords associated with a Storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getActiveTransactions": { + "get": { + "description": "The currently active transactions on a network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowDisasterRecoveryFailback": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowDisasterRecoveryFailover": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedHardware": { + "get": { + "description": "The SoftLayer_Hardware objects which are allowed access to this storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedSubnets": { + "get": { + "description": "The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getAllowedVirtualGuests": { + "get": { + "description": "The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getBillingItem": { + "get": { + "description": "The current billing item for a Storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getBillingItemCategory": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getBytesUsed": { + "get": { + "description": "The amount of space used by the volume, in bytes.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getCreationScheduleId": { + "get": { + "description": "The schedule id which was executed to create a snapshot.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getCredentials": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getDailySchedule": { + "get": { + "description": "The Daily Schedule which is associated with this network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getDependentDuplicate": { + "get": { + "description": "Whether or not a network storage volume is a dependent duplicate.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getDependentDuplicates": { + "get": { + "description": "The network storage volumes configured to be dependent duplicates of a volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getEvents": { + "get": { + "description": "The events which have taken place on a network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFailbackNotAllowed": { + "get": { + "description": "Determines whether the volume is allowed to failback", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFailoverNotAllowed": { + "get": { + "description": "Determines whether the volume is allowed to failover", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFileNetworkMountAddress": { + "get": { + "description": "Retrieves the NFS Network Mount Address Name for a given File Storage Volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getFixReplicationCurrentStatus": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getHardware": { + "get": { + "description": "When applicable, the hardware associated with a Storage service.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getHasEncryptionAtRest": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getHourlySchedule": { + "get": { + "description": "The Hourly Schedule which is associated with this network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIntervalSchedule": { + "get": { + "description": "The Interval Schedule which is associated with this network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIops": { + "get": { + "description": "The maximum number of IOPs selected for this volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsDependentDuplicateProvisionCompleted": { + "get": { + "description": "Determines whether dependent volume provision is completed on background.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsInDedicatedServiceResource": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsMagneticStorage": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIsProvisionInProgress": { + "get": { + "description": "Determines whether network storage volume has an active provision transaction.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIscsiLuns": { + "get": { + "description": "Relationship between a container volume and iSCSI LUNs.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIscsiReplicatingVolume": { + "get": { + "description": "The network storage volumes configured to be replicants of this volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getIscsiTargetIpAddresses": { + "get": { + "description": "Returns the target IP addresses of an iSCSI volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getLunId": { + "get": { + "description": "The ID of the LUN volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getMountPath": { + "get": { + "description": "Retrieves the NFS Network Mount Path for a given File Storage Volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getMountableFlag": { + "get": { + "description": "Whether or not a network storage volume may be mounted.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getNotificationSubscribers": { + "get": { + "description": "The subscribers that will be notified for usage amount warnings and overages.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOriginalSnapshotName": { + "get": { + "description": "The name of the snapshot that this volume was duplicated from.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOriginalVolumeId": { + "get": { + "description": "Volume id of the origin volume from which this volume is been cloned.", + "summary": "", + "externalDocs": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOriginalVolumeName": { + "get": { + "description": "The name of the volume that this volume was duplicated from.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOsType": { + "get": { + "description": "A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getOsTypeId": { + "get": { + "description": "A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getParentVolume": { + "get": { + "description": "The parent volume of a volume in a complex storage relationship.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getPartnerships": { + "get": { + "description": "The volumes or snapshots partnered with a network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getPermissionsGroups": { + "get": { + "description": "All permissions group(s) this volume is in.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getProperties": { + "get": { + "description": "The properties used to provide additional details about a network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getProvisionedIops": { + "get": { + "description": "The number of IOPs provisioned for this volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicatingLuns": { + "get": { + "description": "The iSCSI LUN volumes being replicated by this network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicatingVolume": { + "get": { + "description": "The network storage volume being replicated by a volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicationEvents": { + "get": { + "description": "The volume replication events.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicationPartners": { + "get": { + "description": "The network storage volumes configured to be replicants of a volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getReplicationSchedule": { + "get": { + "description": "The Replication Schedule associated with a network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSchedules": { + "get": { + "description": "The schedules which are associated with a network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getServiceResource": { + "get": { + "description": "The network resource a Storage service is connected to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getServiceResourceBackendIpAddress": { + "get": { + "description": "The IP address of a Storage resource.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getServiceResourceName": { + "get": { + "description": "The name of a Storage's network resource.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotCapacityGb": { + "get": { + "description": "A volume's configured snapshot space size.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotCreationTimestamp": { + "get": { + "description": "The creation timestamp of the snapshot on the storage platform.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotDeletionThresholdPercentage": { + "get": { + "description": "The percentage of used snapshot space after which to delete automated snapshots.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotNotificationStatus": { + "get": { + "description": "Whether or not a network storage volume may be mounted.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotSizeBytes": { + "get": { + "description": "The snapshot size in bytes.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshotSpaceAvailable": { + "get": { + "description": "A volume's available snapshot reservation space.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getSnapshots": { + "get": { + "description": "The snapshots associated with this SoftLayer_Network_Storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getStaasVersion": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getStorageGroups": { + "get": { + "description": "The network storage groups this volume is attached to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getStorageTierLevel": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getStorageType": { + "get": { + "description": "A description of the Storage object.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getTotalBytesUsed": { + "get": { + "description": "The amount of space used by the volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getTotalScheduleSnapshotRetentionCount": { + "get": { + "description": "The total snapshot retention count of all schedules on this network storage volume.", + "summary": "", + "externalDocs": "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": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getUsageNotification": { + "get": { + "description": "The usage notification for SL Storage services.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getVendorName": { + "get": { + "description": "The type of network storage service.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getVirtualGuest": { + "get": { + "description": "When applicable, the virtual guest associated with a Storage service.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getVolumeHistory": { + "get": { + "description": "The username and password history for a Storage service.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getVolumeStatus": { + "get": { + "description": "The current status of a network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getWebccAccount": { + "get": { + "description": "The account username and password for the EVault webCC interface.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getWeeklySchedule": { + "get": { + "description": "The Weekly Schedule which is associated with this network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/assignSubnetsToAcl": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/removeSubnetsFromAcl": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host/{SoftLayer_Network_Storage_Allowed_HostID}/getCredential": { + "get": { + "description": "The SoftLayer_Network_Storage_Credential this allowed host uses.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/assignSubnetsToAcl": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_Hardware/{SoftLayer_Network_Storage_Allowed_Host_HardwareID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_Hardware/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/assignSubnetsToAcl": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_IpAddress/{SoftLayer_Network_Storage_Allowed_Host_IpAddressID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/assignSubnetsToAcl": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_Subnet/{SoftLayer_Network_Storage_Allowed_Host_SubnetID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_Subnet/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/assignSubnetsToAcl": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/{SoftLayer_Network_Storage_Allowed_Host_VirtualGuestID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromHardwareList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromIpAddressList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessFromSubnetList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/allowAccessToReplicantFromIpAddress": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/createFolder": { + "post": { + "description": null, + "summary": "Create a new folder in the root directory.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/deleteFolder": { + "post": { + "description": null, + "summary": "Delete a folder in the root directory.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getCdnUrls": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getClusterResource": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getMaximumExpansionSize": { + "get": { + "description": null, + "summary": "Returns the maximum volume expansion size in GB.", + "externalDocs": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getNetworkMountAddress": { + "get": { + "description": null, + "summary": "Displays the mount path of a storage volume.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getNetworkMountPath": { + "get": { + "description": null, + "summary": "Displays the mount path of a storage volume.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/getObjectStorageConnectionInformation": { + "get": { + "description": null, + "summary": "Retrieve all object storage details for connection", + "externalDocs": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getStorageGroupsNetworkConnectionDetails": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getTargetIpAddresses": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getValidReplicationTargetDatacenterLocations": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/isBlockingOperationInProgress": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/isVolumeActive": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromIpAddressList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromSubnet": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessFromSubnetList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/removeAccessToReplicantFromSubnet": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/setSnapshotAllocation": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAccount": { + "get": { + "description": "The account that a Storage services belongs to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAccountPassword": { + "get": { + "description": "Other usernames and passwords associated with a Storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getActiveTransactions": { + "get": { + "description": "The currently active transactions on a network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowDisasterRecoveryFailback": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getAllowDisasterRecoveryFailover": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getBillingItem": { + "get": { + "description": "The current billing item for a Storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getBillingItemCategory": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getCredentials": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFailbackNotAllowed": { + "get": { + "description": "Determines whether the volume is allowed to failback", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFailoverNotAllowed": { + "get": { + "description": "Determines whether the volume is allowed to failover", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getFixReplicationCurrentStatus": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getHardware": { + "get": { + "description": "When applicable, the hardware associated with a Storage service.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getHasEncryptionAtRest": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIops": { + "get": { + "description": "The maximum number of IOPs selected for this volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIsDependentDuplicateProvisionCompleted": { + "get": { + "description": "Determines whether dependent volume provision is completed on background.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIsInDedicatedServiceResource": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIsMagneticStorage": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIscsiLuns": { + "get": { + "description": "Relationship between a container volume and iSCSI LUNs.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getIscsiTargetIpAddresses": { + "get": { + "description": "Returns the target IP addresses of an iSCSI volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getLunId": { + "get": { + "description": "The ID of the LUN volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getPermissionsGroups": { + "get": { + "description": "All permissions group(s) this volume is in.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getProvisionedIops": { + "get": { + "description": "The number of IOPs provisioned for this volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getReplicatingVolume": { + "get": { + "description": "The network storage volume being replicated by a volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getReplicationEvents": { + "get": { + "description": "The volume replication events.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getReplicationSchedule": { + "get": { + "description": "The Replication Schedule associated with a network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getServiceResource": { + "get": { + "description": "The network resource a Storage service is connected to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getServiceResourceBackendIpAddress": { + "get": { + "description": "The IP address of a Storage resource.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getServiceResourceName": { + "get": { + "description": "The name of a Storage's network resource.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshotCapacityGb": { + "get": { + "description": "A volume's configured snapshot space size.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshotSizeBytes": { + "get": { + "description": "The snapshot size in bytes.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshotSpaceAvailable": { + "get": { + "description": "A volume's available snapshot reservation space.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getSnapshots": { + "get": { + "description": "The snapshots associated with this SoftLayer_Network_Storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getStaasVersion": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getStorageGroups": { + "get": { + "description": "The network storage groups this volume is attached to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getStorageTierLevel": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getStorageType": { + "get": { + "description": "A description of the Storage object.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getTotalBytesUsed": { + "get": { + "description": "The amount of space used by the volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getUsageNotification": { + "get": { + "description": "The usage notification for SL Storage services.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getVendorName": { + "get": { + "description": "The type of network storage service.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getVolumeHistory": { + "get": { + "description": "The username and password history for a Storage service.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getVolumeStatus": { + "get": { + "description": "The current status of a network storage volume.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_DedicatedCluster/getDedicatedClusterList": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_DedicatedCluster/{SoftLayer_Network_Storage_DedicatedClusterID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_DedicatedCluster record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_DedicatedCluster/{SoftLayer_Network_Storage_DedicatedClusterID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_DedicatedCluster/{SoftLayer_Network_Storage_DedicatedClusterID}/getServiceResource": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/createObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/deleteObject": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/getAllObjects": { + "get": { + "description": "Use this method to retrieve all network storage groups. ", + "summary": "Returns all network storage groups", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_Group record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getAccount": { + "get": { + "description": "The SoftLayer_Account which owns this group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getAllowedHosts": { + "get": { + "description": "The allowed hosts list for this group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getAttachedVolumes": { + "get": { + "description": "The network storage volumes this group is attached to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getGroupType": { + "get": { + "description": "The type which defines this group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getOsType": { + "get": { + "description": "The OS Type this group is configured for.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group/{SoftLayer_Network_Storage_GroupID}/getServiceResource": { + "get": { + "description": "The network resource this group is created on.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_Group_Iscsi record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/createObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/deleteObject": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/getAllObjects": { + "get": { + "description": "Use this method to retrieve all network storage groups. ", + "summary": "Returns all network storage groups", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getAccount": { + "get": { + "description": "The SoftLayer_Account which owns this group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getAllowedHosts": { + "get": { + "description": "The allowed hosts list for this group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getAttachedVolumes": { + "get": { + "description": "The network storage volumes this group is attached to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getGroupType": { + "get": { + "description": "The type which defines this group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getOsType": { + "get": { + "description": "The OS Type this group is configured for.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Iscsi/{SoftLayer_Network_Storage_Group_IscsiID}/getServiceResource": { + "get": { + "description": "The network resource this group is created on.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_Group_Nfs record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/createObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/deleteObject": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/getAllObjects": { + "get": { + "description": "Use this method to retrieve all network storage groups. ", + "summary": "Returns all network storage groups", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getAccount": { + "get": { + "description": "The SoftLayer_Account which owns this group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getAllowedHosts": { + "get": { + "description": "The allowed hosts list for this group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getAttachedVolumes": { + "get": { + "description": "The network storage volumes this group is attached to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getGroupType": { + "get": { + "description": "The type which defines this group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getOsType": { + "get": { + "description": "The OS Type this group is configured for.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Group_Nfs/{SoftLayer_Network_Storage_Group_NfsID}/getServiceResource": { + "get": { + "description": "The network resource this group is created on.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/credentialDelete": { + "post": { + "description": "Delete a credential ", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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[ , ] \n\nif not 200: \n\n[ , ] \n\n\n\n{ \"start\": \"\", \"errors\": [], \"end\": \"\", \"resource_type\": \"account\", \"warnings\": [], \"resources\": [{\"metrics\" : [{\"name\": \"retrieval\", \"value\": \"\"}]}] } \n\nNotes: 1) When no data is found for a particular triplet (resource_id, storage_location, storage_class) a JSON element is inserted to the warnings Array. 2) If all queried triplets find data, only the resources Array will be populated, errors and warnings will remain empty. \n\n", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCloudObjectStorageMetrics/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getCloudObjectStorageMetrics", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getCredentialLimit": { + "get": { + "description": "Returns credential limits for this IBM Cloud Object Storage account. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentialLimit/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getCredentialLimit", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getEndpoints": { + "post": { + "description": "Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpoints/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getEndpoints", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getEndpointsWithRefetch": { + "post": { + "description": "Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpointsWithRefetch/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getEndpointsWithRefetch", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_Hub_Cleversafe_Account record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getObject/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Hub_Cleversafe_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getAccount": { + "get": { + "description": "SoftLayer account to which an IBM Cloud Object Storage account belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAccount/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getBillingItem": { + "get": { + "description": "An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBillingItem/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getCancelledBillingItem": { + "get": { + "description": "An associated parent billing item which has been cancelled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCancelledBillingItem/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getCancelledBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getCredentials": { + "get": { + "description": "Credentials used for generating an AWS signature. Max of 2.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentials/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getCredentials", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getMetricTrackingObject": { + "get": { + "description": "Provides an interface to various metrics relating to the usage of an IBM Cloud Object Storage account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getMetricTrackingObject/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Cleversafe_Account/{SoftLayer_Network_Storage_Hub_Cleversafe_AccountID}/getUuid": { + "get": { + "description": "Unique identifier for an IBM Cloud Object Storage account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getUuid/", + "operationId": "SoftLayer_Network_Storage_Hub_Cleversafe_Account::getUuid", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Swift_Metrics/{SoftLayer_Network_Storage_Hub_Swift_MetricsID}/getMetricData": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getMetricData/", + "operationId": "SoftLayer_Network_Storage_Hub_Swift_Metrics::getMetricData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Swift_Metrics/{SoftLayer_Network_Storage_Hub_Swift_MetricsID}/getSummaryData": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getSummaryData/", + "operationId": "SoftLayer_Network_Storage_Hub_Swift_Metrics::getSummaryData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Swift_Share/getContainerList": { + "get": { + "description": "This method returns a collection of container objects. ", + "summary": "Get a list of the file containers for a brand.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getContainerList/", + "operationId": "SoftLayer_Network_Storage_Hub_Swift_Share::getContainerList", + "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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Swift_Share/getFile": { + "post": { + "description": "This method returns a file object given the file's full name. ", + "summary": "Download a file.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFile/", + "operationId": "SoftLayer_Network_Storage_Hub_Swift_Share::getFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_File" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Hub_Swift_Share/getFileList": { + "post": { + "description": "This method returns a collection of the file objects within a container and the given path. ", + "summary": "Get a list of the files in a container and path.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFileList/", + "operationId": "SoftLayer_Network_Storage_Hub_Swift_Share::getFileList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardware/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessFromHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/allowAccessFromIpAddress": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddress/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessFromIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuest/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessFromVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/allowAccessToReplicantFromHardwareList": { + "post": { + "description": "This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replica volume. ", + "summary": "allow access to this replica volume from multiple SoftLayer_Hardware objects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardwareList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromHardwareList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/allowAccessToReplicantFromIpAddressList": { + "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 allowedVirtualGuests property of this storage volume. ", + "summary": "allow access to this volume from multiple SoftLayer_Network_Subnet_IpAddress objects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddressList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromIpAddressList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/allowAccessToReplicantFromVirtualGuestList": { + "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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuestList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromVirtualGuestList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/createOrUpdateLunId/", + "operationId": "SoftLayer_Network_Storage_Iscsi::createOrUpdateLunId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Property" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getMaximumExpansionSize": { + "get": { + "description": null, + "summary": "Returns the maximum volume expansion size in GB.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getMaximumExpansionSize/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getMaximumExpansionSize", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_Iscsi record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getObject/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Iscsi" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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 of snapshots for a given volume.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotsForVolume/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getSnapshotsForVolume", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardware/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessFromHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/removeAccessFromIpAddress": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddress/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessFromIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuest/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessFromVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/removeAccessToReplicantFromHardwareList": { + "post": { + "description": "This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replica volume. ", + "summary": "Remove access to this volume from multiple SoftLayer_Hardware objects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromHardwareList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessToReplicantFromHardwareList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/removeAccessToReplicantFromIpAddressList": { + "post": { + "description": "This method is used to modify the access control list for this Storage replica 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 replica volume. ", + "summary": "Remove access to this replica volume from multiple SoftLayer_Network_Subnet_IpAddress objects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromIpAddressList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessToReplicantFromIpAddressList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/removeAccessToReplicantFromVirtualGuestList": { + "post": { + "description": "This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replica volume. ", + "summary": "Remove access to this replica volume from multiple SoftLayer_Virtual_Guest objects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromVirtualGuestList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessToReplicantFromVirtualGuestList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/allowAccessFromHardwareList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardwareList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessFromHardwareList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHost/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessFromHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHostList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessFromHostList", + "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_Iscsi/{SoftLayer_Network_Storage_IscsiID}/allowAccessFromIpAddressList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddressList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessFromIpAddressList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnet/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessFromSubnet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/allowAccessFromSubnetList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnetList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessFromSubnetList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuestList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessFromVirtualGuestList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardware/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/allowAccessToReplicantFromIpAddress": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddress/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnet/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromSubnet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnetList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromSubnetList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuest/", + "operationId": "SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/assignCredential/", + "operationId": "SoftLayer_Network_Storage_Iscsi::assignCredential", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/assignNewCredential/", + "operationId": "SoftLayer_Network_Storage_Iscsi::assignNewCredential", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/changePassword/", + "operationId": "SoftLayer_Network_Storage_Iscsi::changePassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/collectBandwidth/", + "operationId": "SoftLayer_Network_Storage_Iscsi::collectBandwidth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/collectBytesUsed/", + "operationId": "SoftLayer_Network_Storage_Iscsi::collectBytesUsed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/convertCloneDependentToIndependent": { + "get": { + "description": null, + "summary": "Splits a clone from its parent allowing it to be an independent volume.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/convertCloneDependentToIndependent/", + "operationId": "SoftLayer_Network_Storage_Iscsi::convertCloneDependentToIndependent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/createFolder": { + "post": { + "description": null, + "summary": "Create a new folder in the root directory.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/createFolder/", + "operationId": "SoftLayer_Network_Storage_Iscsi::createFolder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/createSnapshot": { + "post": { + "description": null, + "summary": "Manually create a new snapshot of a storage volume.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/createSnapshot/", + "operationId": "SoftLayer_Network_Storage_Iscsi::createSnapshot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/deleteAllFiles/", + "operationId": "SoftLayer_Network_Storage_Iscsi::deleteAllFiles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFile/", + "operationId": "SoftLayer_Network_Storage_Iscsi::deleteFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFiles/", + "operationId": "SoftLayer_Network_Storage_Iscsi::deleteFiles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/deleteFolder": { + "post": { + "description": null, + "summary": "Delete a folder in the root directory.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFolder/", + "operationId": "SoftLayer_Network_Storage_Iscsi::deleteFolder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/deleteObject/", + "operationId": "SoftLayer_Network_Storage_Iscsi::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/disableSnapshots/", + "operationId": "SoftLayer_Network_Storage_Iscsi::disableSnapshots", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/disasterRecoveryFailoverToReplicant/", + "operationId": "SoftLayer_Network_Storage_Iscsi::disasterRecoveryFailoverToReplicant", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/downloadFile/", + "operationId": "SoftLayer_Network_Storage_Iscsi::downloadFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/editCredential/", + "operationId": "SoftLayer_Network_Storage_Iscsi::editCredential", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/editObject/", + "operationId": "SoftLayer_Network_Storage_Iscsi::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/enableSnapshots/", + "operationId": "SoftLayer_Network_Storage_Iscsi::enableSnapshots", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/failbackFromReplicant/", + "operationId": "SoftLayer_Network_Storage_Iscsi::failbackFromReplicant", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/failoverToReplicant/", + "operationId": "SoftLayer_Network_Storage_Iscsi::failoverToReplicant", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFiles/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllFiles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFilesByFilter/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllFilesByFilter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableHardware/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowableHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableIpAddresses/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowableIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableSubnets/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowableSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableVirtualGuests/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowableVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHostsLimit/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowedHostsLimit", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getByUsername/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getByUsername", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getCdnUrls": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getCdnUrls/", + "operationId": "SoftLayer_Network_Storage_Iscsi::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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getClusterResource": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getClusterResource/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getClusterResource", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getDuplicateConversionStatus/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getDuplicateConversionStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFileBlockEncryptedLocations/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getFileBlockEncryptedLocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFileByIdentifier/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getFileByIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFileCount/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getFileCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getFileList": { + "post": { + "description": null, + "summary": "Retrieve list of files in a given folder for this account.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFileList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getFileList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFilePendingDeleteCount/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getFilePendingDeleteCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFilesPendingDelete/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getFilesPendingDelete", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getFolderList": { + "get": { + "description": null, + "summary": "Retrieve a list of level 1 folders for this account.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFolderList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::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": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getGraph/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getGraph", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getNetworkConnectionDetails": { + "get": { + "description": null, + "summary": "Retrieve network connection details for complex network storage volumes.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkConnectionDetails/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getNetworkConnectionDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_NetworkConnectionInformation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getNetworkMountAddress": { + "get": { + "description": null, + "summary": "Displays the mount path of a storage volume.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountAddress/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getNetworkMountAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getNetworkMountPath": { + "get": { + "description": null, + "summary": "Displays the mount path of a storage volume.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountPath/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getNetworkMountPath", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/getObjectStorageConnectionInformation": { + "get": { + "description": null, + "summary": "Retrieve all object storage details for connection", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectStorageConnectionInformation/", + "operationId": "SoftLayer_Network_Storage_Iscsi::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_Iscsi/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectsByCredential/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getObjectsByCredential", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getRecycleBinFileByIdentifier/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getRecycleBinFileByIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getRemainingAllowedHosts": { + "get": { + "description": "Retrieves the remaining number of allowed hosts per volume. ", + "summary": "Retrieves the remaining number of allowed hosts per volume.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHosts/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getRemainingAllowedHosts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHostsForReplicant/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getRemainingAllowedHostsForReplicant", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getReplicationTimestamp": { + "get": { + "description": null, + "summary": "An API call to fetch the last timestamp of the replication process", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationTimestamp/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getReplicationTimestamp", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getStorageGroupsNetworkConnectionDetails": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroupsNetworkConnectionDetails/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getStorageGroupsNetworkConnectionDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_NetworkConnectionInformation" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getTargetIpAddresses": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getTargetIpAddresses/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getTargetIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getValidReplicationTargetDatacenterLocations": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getValidReplicationTargetDatacenterLocations/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getValidReplicationTargetDatacenterLocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeCountLimits/", + "operationId": "SoftLayer_Network_Storage_Iscsi::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_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getVolumeDuplicateParameters": { + "get": { + "description": "This method returns the parameters for cloning a volume ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeDuplicateParameters/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getVolumeDuplicateParameters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_VolumeDuplicateParameters" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/immediateFailoverToReplicant/", + "operationId": "SoftLayer_Network_Storage_Iscsi::immediateFailoverToReplicant", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/initiateOriginVolumeReclaim": { + "get": { + "description": null, + "summary": "Initiates Origin Volume Reclaim to delete volume from NetApp.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/initiateOriginVolumeReclaim/", + "operationId": "SoftLayer_Network_Storage_Iscsi::initiateOriginVolumeReclaim", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/initiateVolumeCutover": { + "get": { + "description": null, + "summary": "Initiates Volume Cutover to remove access from the old volume.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/initiateVolumeCutover/", + "operationId": "SoftLayer_Network_Storage_Iscsi::initiateVolumeCutover", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/isBlockingOperationInProgress": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/isBlockingOperationInProgress/", + "operationId": "SoftLayer_Network_Storage_Iscsi::isBlockingOperationInProgress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyForSnapshot/", + "operationId": "SoftLayer_Network_Storage_Iscsi::isDuplicateReadyForSnapshot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyToMount/", + "operationId": "SoftLayer_Network_Storage_Iscsi::isDuplicateReadyToMount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/isVolumeActive": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/isVolumeActive/", + "operationId": "SoftLayer_Network_Storage_Iscsi::isVolumeActive", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/refreshDependentDuplicate": { + "post": { + "description": null, + "summary": "Refreshes a duplicate volume with a snapshot taken from its parent. This is deprecated now.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDependentDuplicate/", + "operationId": "SoftLayer_Network_Storage_Iscsi::refreshDependentDuplicate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/refreshDuplicate": { + "post": { + "description": null, + "summary": "Refreshes any duplicate volume with a snapshot taken from its parent.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDuplicate/", + "operationId": "SoftLayer_Network_Storage_Iscsi::refreshDuplicate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardwareList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessFromHardwareList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHost/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessFromHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHostList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessFromHostList", + "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_Iscsi/{SoftLayer_Network_Storage_IscsiID}/removeAccessFromIpAddressList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddressList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessFromIpAddressList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/removeAccessFromSubnet": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnet/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessFromSubnet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/removeAccessFromSubnetList": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnetList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessFromSubnetList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuestList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessFromVirtualGuestList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/removeAccessToReplicantFromSubnet": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnet/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessToReplicantFromSubnet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnetList/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeAccessToReplicantFromSubnetList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/removeCredential/", + "operationId": "SoftLayer_Network_Storage_Iscsi::removeCredential", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFile/", + "operationId": "SoftLayer_Network_Storage_Iscsi::restoreFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/restoreFromSnapshot": { + "post": { + "description": "Restore the volume from a snapshot that was previously taken. ", + "summary": "Restore from a volume snapshot.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFromSnapshot/", + "operationId": "SoftLayer_Network_Storage_Iscsi::restoreFromSnapshot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/sendPasswordReminderEmail/", + "operationId": "SoftLayer_Network_Storage_Iscsi::sendPasswordReminderEmail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/setMountable/", + "operationId": "SoftLayer_Network_Storage_Iscsi::setMountable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/setSnapshotAllocation": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotAllocation/", + "operationId": "SoftLayer_Network_Storage_Iscsi::setSnapshotAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/setSnapshotNotification": { + "post": { + "description": "Function to enable/disable snapshot warning notification. ", + "summary": "Function to enable/disable snapshot warning notification.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotNotification/", + "operationId": "SoftLayer_Network_Storage_Iscsi::setSnapshotNotification", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/upgradeVolumeCapacity/", + "operationId": "SoftLayer_Network_Storage_Iscsi::upgradeVolumeCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/uploadFile/", + "operationId": "SoftLayer_Network_Storage_Iscsi::uploadFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/validateHostsAccess/", + "operationId": "SoftLayer_Network_Storage_Iscsi::validateHostsAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Network_Storage_HostsGatewayInformation" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAccount": { + "get": { + "description": "The account that a Storage services belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAccount/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAccountPassword": { + "get": { + "description": "Other usernames and passwords associated with a Storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAccountPassword/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAccountPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Password" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getActiveTransactions": { + "get": { + "description": "The currently active transactions on a network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getActiveTransactions/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getActiveTransactions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAllowDisasterRecoveryFailback": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailback/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowDisasterRecoveryFailback", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAllowDisasterRecoveryFailover": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailover/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowDisasterRecoveryFailover", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAllowedHardware": { + "get": { + "description": "The SoftLayer_Hardware objects which are allowed access to this storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHardware/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowedHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAllowedIpAddresses": { + "get": { + "description": "The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedIpAddresses/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowedIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAllowedReplicationHardware": { + "get": { + "description": "The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationHardware/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowedReplicationHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAllowedReplicationIpAddresses": { + "get": { + "description": "The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationIpAddresses/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowedReplicationIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAllowedReplicationSubnets": { + "get": { + "description": "The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationSubnets/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowedReplicationSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAllowedReplicationVirtualGuests": { + "get": { + "description": "The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationVirtualGuests/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowedReplicationVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAllowedSubnets": { + "get": { + "description": "The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedSubnets/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowedSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getAllowedVirtualGuests": { + "get": { + "description": "The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedVirtualGuests/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getAllowedVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getBillingItem": { + "get": { + "description": "The current billing item for a Storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItem/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getBillingItemCategory": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItemCategory/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getBillingItemCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getBytesUsed": { + "get": { + "description": "The amount of space used by the volume, in bytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getBytesUsed/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getBytesUsed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getCreationScheduleId": { + "get": { + "description": "The schedule id which was executed to create a snapshot.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getCreationScheduleId/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getCreationScheduleId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getCredentials": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getCredentials/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getCredentials", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Credential" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getDailySchedule": { + "get": { + "description": "The Daily Schedule which is associated with this network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getDailySchedule/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getDailySchedule", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getDependentDuplicate": { + "get": { + "description": "Whether or not a network storage volume is a dependent duplicate.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicate/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getDependentDuplicate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getDependentDuplicates": { + "get": { + "description": "The network storage volumes configured to be dependent duplicates of a volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicates/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getDependentDuplicates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getEvents": { + "get": { + "description": "The events which have taken place on a network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getEvents/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getFailbackNotAllowed": { + "get": { + "description": "Determines whether the volume is allowed to failback", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFailbackNotAllowed/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getFailbackNotAllowed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getFailoverNotAllowed": { + "get": { + "description": "Determines whether the volume is allowed to failover", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFailoverNotAllowed/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getFailoverNotAllowed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getFileNetworkMountAddress": { + "get": { + "description": "Retrieves the NFS Network Mount Address Name for a given File Storage Volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFileNetworkMountAddress/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getFileNetworkMountAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getFixReplicationCurrentStatus": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getFixReplicationCurrentStatus/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getFixReplicationCurrentStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getHardware": { + "get": { + "description": "When applicable, the hardware associated with a Storage service.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getHardware/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getHasEncryptionAtRest": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getHasEncryptionAtRest/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getHasEncryptionAtRest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getHourlySchedule": { + "get": { + "description": "The Hourly Schedule which is associated with this network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getHourlySchedule/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getHourlySchedule", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getIntervalSchedule": { + "get": { + "description": "The Interval Schedule which is associated with this network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIntervalSchedule/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIntervalSchedule", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getIops": { + "get": { + "description": "The maximum number of IOPs selected for this volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIops/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIops", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getIsConvertToIndependentTransactionInProgress": { + "get": { + "description": "Determines whether network storage volume has an active convert dependent clone to Independent transaction.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIsConvertToIndependentTransactionInProgress/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIsConvertToIndependentTransactionInProgress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getIsDependentDuplicateProvisionCompleted": { + "get": { + "description": "Determines whether dependent volume provision is completed on background.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIsDependentDuplicateProvisionCompleted/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIsDependentDuplicateProvisionCompleted", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getIsInDedicatedServiceResource": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIsInDedicatedServiceResource/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIsInDedicatedServiceResource", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getIsMagneticStorage": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIsMagneticStorage/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIsMagneticStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getIsProvisionInProgress": { + "get": { + "description": "Determines whether network storage volume has an active provision transaction.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIsProvisionInProgress/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIsProvisionInProgress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyForSnapshot/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIsReadyForSnapshot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyToMount/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIsReadyToMount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getIscsiLuns": { + "get": { + "description": "Relationship between a container volume and iSCSI LUNs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiLuns/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIscsiLuns", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getIscsiReplicatingVolume": { + "get": { + "description": "The network storage volumes configured to be replicants of this volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiReplicatingVolume/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIscsiReplicatingVolume", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getIscsiTargetIpAddresses": { + "get": { + "description": "Returns the target IP addresses of an iSCSI volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiTargetIpAddresses/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getIscsiTargetIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getLunId": { + "get": { + "description": "The ID of the LUN volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getLunId/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getLunId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getManualSnapshots/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getManualSnapshots", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getMetricTrackingObject": { + "get": { + "description": "A network storage volume's metric tracking object. This object records all periodic polled data available to this volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getMetricTrackingObject/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getMountPath": { + "get": { + "description": "Retrieves the NFS Network Mount Path for a given File Storage Volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getMountPath/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getMountPath", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getMountableFlag": { + "get": { + "description": "Whether or not a network storage volume may be mounted.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getMountableFlag/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getMountableFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getMoveAndSplitStatus": { + "get": { + "description": "The current status of split or move operation as a part of volume duplication.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getMoveAndSplitStatus/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getMoveAndSplitStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getNotificationSubscribers": { + "get": { + "description": "The subscribers that will be notified for usage amount warnings and overages.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getNotificationSubscribers/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getNotificationSubscribers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getOriginalSnapshotName": { + "get": { + "description": "The name of the snapshot that this volume was duplicated from.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalSnapshotName/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getOriginalSnapshotName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getOriginalVolumeId": { + "get": { + "description": "Volume id of the origin volume from which this volume is been cloned.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeId/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getOriginalVolumeId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getOriginalVolumeName": { + "get": { + "description": "The name of the volume that this volume was duplicated from.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeName/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getOriginalVolumeName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeSize/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getOriginalVolumeSize", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getOsType": { + "get": { + "description": "A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getOsType/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getOsType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Iscsi_OS_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getOsTypeId": { + "get": { + "description": "A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getOsTypeId/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getOsTypeId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getParentPartnerships": { + "get": { + "description": "The volumes or snapshots partnered with a network storage volume in a parental role.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getParentPartnerships/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getParentPartnerships", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Partnership" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getParentVolume": { + "get": { + "description": "The parent volume of a volume in a complex storage relationship.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getParentVolume/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getParentVolume", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getPartnerships": { + "get": { + "description": "The volumes or snapshots partnered with a network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getPartnerships/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getPartnerships", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Partnership" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getPermissionsGroups": { + "get": { + "description": "All permissions group(s) this volume is in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getPermissionsGroups/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getPermissionsGroups", + "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_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getProperties": { + "get": { + "description": "The properties used to provide additional details about a network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getProperties/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getProperties", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Property" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getProvisionedIops": { + "get": { + "description": "The number of IOPs provisioned for this volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getProvisionedIops/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getProvisionedIops", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getReplicatingLuns": { + "get": { + "description": "The iSCSI LUN volumes being replicated by this network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingLuns/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getReplicatingLuns", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getReplicatingVolume": { + "get": { + "description": "The network storage volume being replicated by a volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingVolume/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getReplicatingVolume", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getReplicationEvents": { + "get": { + "description": "The volume replication events.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationEvents/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getReplicationEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getReplicationPartners": { + "get": { + "description": "The network storage volumes configured to be replicants of a volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationPartners/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getReplicationPartners", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getReplicationSchedule": { + "get": { + "description": "The Replication Schedule associated with a network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationSchedule/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getReplicationSchedule", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getReplicationStatus": { + "get": { + "description": "The current replication status of a network storage volume. Indicates Failover or Failback status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationStatus/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getReplicationStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getSchedules": { + "get": { + "description": "The schedules which are associated with a network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getSchedules/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getSchedules", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getServiceResource": { + "get": { + "description": "The network resource a Storage service is connected to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResource/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getServiceResource", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getServiceResourceBackendIpAddress": { + "get": { + "description": "The IP address of a Storage resource.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceBackendIpAddress/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getServiceResourceBackendIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getServiceResourceName": { + "get": { + "description": "The name of a Storage's network resource.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceName/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getServiceResourceName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getSnapshotCapacityGb": { + "get": { + "description": "A volume's configured snapshot space size.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCapacityGb/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getSnapshotCapacityGb", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getSnapshotCreationTimestamp": { + "get": { + "description": "The creation timestamp of the snapshot on the storage platform.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCreationTimestamp/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getSnapshotCreationTimestamp", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getSnapshotDeletionThresholdPercentage": { + "get": { + "description": "The percentage of used snapshot space after which to delete automated snapshots.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotDeletionThresholdPercentage/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getSnapshotDeletionThresholdPercentage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getSnapshotNotificationStatus": { + "get": { + "description": "Whether or not a network storage volume may be mounted.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotNotificationStatus/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getSnapshotNotificationStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getSnapshotSizeBytes": { + "get": { + "description": "The snapshot size in bytes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSizeBytes/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getSnapshotSizeBytes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getSnapshotSpaceAvailable": { + "get": { + "description": "A volume's available snapshot reservation space.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSpaceAvailable/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getSnapshotSpaceAvailable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getSnapshots": { + "get": { + "description": "The snapshots associated with this SoftLayer_Network_Storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshots/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getSnapshots", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getStaasVersion": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getStaasVersion/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getStaasVersion", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getStorageGroups": { + "get": { + "description": "The network storage groups this volume is attached to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroups/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getStorageGroups", + "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_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getStorageTierLevel": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageTierLevel/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getStorageTierLevel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getStorageType": { + "get": { + "description": "A description of the Storage object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageType/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getStorageType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getTotalBytesUsed": { + "get": { + "description": "The amount of space used by the volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalBytesUsed/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getTotalBytesUsed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getTotalScheduleSnapshotRetentionCount": { + "get": { + "description": "The total snapshot retention count of all schedules on this network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalScheduleSnapshotRetentionCount/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getTotalScheduleSnapshotRetentionCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getUsageNotification": { + "get": { + "description": "The usage notification for SL Storage services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getUsageNotification/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getUsageNotification", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getVendorName": { + "get": { + "description": "The type of network storage service.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getVendorName/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getVendorName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getVirtualGuest": { + "get": { + "description": "When applicable, the virtual guest associated with a Storage service.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getVirtualGuest/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getVolumeHistory": { + "get": { + "description": "The username and password history for a Storage service.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeHistory/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getVolumeHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getVolumeStatus": { + "get": { + "description": "The current status of a network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeStatus/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getVolumeStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getWebccAccount": { + "get": { + "description": "The account username and password for the EVault webCC interface.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getWebccAccount/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getWebccAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Password" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getWeeklySchedule": { + "get": { + "description": "The Weekly Schedule which is associated with this network storage volume.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi/getWeeklySchedule/", + "operationId": "SoftLayer_Network_Storage_Iscsi::getWeeklySchedule", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi_OS_Type/getAllObjects": { + "get": { + "description": "Use this method to retrieve all iSCSI OS Types. ", + "summary": "Returns all iSCSI OS Types", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getAllObjects/", + "operationId": "SoftLayer_Network_Storage_Iscsi_OS_Type::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Iscsi_OS_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Iscsi_OS_Type/{SoftLayer_Network_Storage_Iscsi_OS_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_Iscsi_OS_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getObject/", + "operationId": "SoftLayer_Network_Storage_Iscsi_OS_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Iscsi_OS_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/{SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_XrefID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getObject/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion": { + "post": { + "description": "Returns countries assigned to the region having pricing info set. ", + "summary": "return countries assigned to the region having pricing info set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref::getValidCountriesForRegion", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/{SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_XrefID}/getCountry": { + "get": { + "description": "SoftLayer_Locale_Country Id.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getCountry/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref::getCountry", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale_Country" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/{SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_XrefID}/getLocationGroup": { + "get": { + "description": "Location Group ID of CleverSafe cross region.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getLocationGroup/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref::getLocationGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses": { + "get": { + "description": "Retrieves a list of all the possible statuses to which a request may be set.", + "summary": "Retrieves a list of all the possible statuses", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getAllRequestStatuses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_Request_Status" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getObject/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests": { + "get": { + "description": "Returns placeholder MDMS requests for any MDMS order pending approval. ", + "summary": "Returns placeholder MDMS requests for any MDMS order pending approval.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getPendingRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getAccount": { + "get": { + "description": "The account to which the request belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAccount/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getActiveTickets": { + "get": { + "description": "The active tickets that are attached to the MDMS request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getActiveTickets/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getActiveTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getAddress": { + "get": { + "description": "The customer address where the device is shipped to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAddress/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Address" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getBillingItem": { + "get": { + "description": "An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getBillingItem/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getCreateEmployee": { + "get": { + "description": "The employee user who created the request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateEmployee/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getCreateEmployee", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Employee" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getCreateUser": { + "get": { + "description": "The customer user who created the request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateUser/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getCreateUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getDeviceConfiguration": { + "get": { + "description": "The device configurations.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceConfiguration/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getDeviceConfiguration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getDeviceModel": { + "get": { + "description": "The model of device assigned to this request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceModel/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getDeviceModel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getKeyContacts": { + "get": { + "description": "The key contacts for this requests.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getKeyContacts/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getKeyContacts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getModifyEmployee": { + "get": { + "description": "The employee who last modified the request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyEmployee/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getModifyEmployee", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Employee" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getModifyUser": { + "get": { + "description": "The customer user who last modified the request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyUser/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getModifyUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getShipments": { + "get": { + "description": "The shipments of the request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getShipments/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getShipments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Shipment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getStatus": { + "get": { + "description": "The status of the request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getStatus/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_Request_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getTicket": { + "get": { + "description": "Ticket that is attached to this mass data migration request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTicket/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getTickets": { + "get": { + "description": "All tickets that are attached to the mass data migration request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTickets/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request::getTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/{SoftLayer_Network_Storage_MassDataMigration_Request_KeyContactID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getObject/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/{SoftLayer_Network_Storage_MassDataMigration_Request_KeyContactID}/getAccount": { + "get": { + "description": "The request this key contact belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getAccount/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/{SoftLayer_Network_Storage_MassDataMigration_Request_KeyContactID}/getRequest": { + "get": { + "description": "The request this key contact belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getRequest/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact::getRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_MassDataMigration_Request_Status/{SoftLayer_Network_Storage_MassDataMigration_Request_StatusID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_Status record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/getObject/", + "operationId": "SoftLayer_Network_Storage_MassDataMigration_Request_Status::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_MassDataMigration_Request_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/createObject": { + "post": { + "description": "Create a nas volume schedule ", + "summary": "Create a nas volume schedule", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/createObject/", + "operationId": "SoftLayer_Network_Storage_Schedule::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/deleteObject": { + "get": { + "description": "Delete a network storage schedule. '''This cannot be undone.''' ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a schedule; ", + "summary": "Delete a network storage schedule", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/deleteObject/", + "operationId": "SoftLayer_Network_Storage_Schedule::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/editObject": { + "post": { + "description": "Edit a nas volume schedule ", + "summary": "Edit a nas volume schedule", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/editObject/", + "operationId": "SoftLayer_Network_Storage_Schedule::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_Schedule record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getObject/", + "operationId": "SoftLayer_Network_Storage_Schedule::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getDay": { + "get": { + "description": "The hour parameter of this schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getDay/", + "operationId": "SoftLayer_Network_Storage_Schedule::getDay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getDayOfMonth": { + "get": { + "description": "The day of the month parameter of this schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfMonth/", + "operationId": "SoftLayer_Network_Storage_Schedule::getDayOfMonth", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getDayOfWeek": { + "get": { + "description": "The day of the week parameter of this schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfWeek/", + "operationId": "SoftLayer_Network_Storage_Schedule::getDayOfWeek", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getEvents": { + "get": { + "description": "Events which have been created as the result of a schedule execution.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getEvents/", + "operationId": "SoftLayer_Network_Storage_Schedule::getEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getHour": { + "get": { + "description": "The hour parameter of this schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getHour/", + "operationId": "SoftLayer_Network_Storage_Schedule::getHour", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getMinute": { + "get": { + "description": "The minute parameter of this schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getMinute/", + "operationId": "SoftLayer_Network_Storage_Schedule::getMinute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getMonthOfYear": { + "get": { + "description": "The month of the year parameter of this schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getMonthOfYear/", + "operationId": "SoftLayer_Network_Storage_Schedule::getMonthOfYear", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getPartnership": { + "get": { + "description": "The associated partnership for a schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getPartnership/", + "operationId": "SoftLayer_Network_Storage_Schedule::getPartnership", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Partnership" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getProperties": { + "get": { + "description": "Properties used for configuration of a schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getProperties/", + "operationId": "SoftLayer_Network_Storage_Schedule::getProperties", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule_Property" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getReplicaSnapshots": { + "get": { + "description": "Replica snapshots which have been created as the result of this schedule's execution.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getReplicaSnapshots/", + "operationId": "SoftLayer_Network_Storage_Schedule::getReplicaSnapshots", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getRetentionCount": { + "get": { + "description": "The number of snapshots this schedule is configured to retain.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getRetentionCount/", + "operationId": "SoftLayer_Network_Storage_Schedule::getRetentionCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getSecond": { + "get": { + "description": "The minute parameter of this schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getSecond/", + "operationId": "SoftLayer_Network_Storage_Schedule::getSecond", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getSnapshots": { + "get": { + "description": "Snapshots which have been created as the result of this schedule's execution.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getSnapshots/", + "operationId": "SoftLayer_Network_Storage_Schedule::getSnapshots", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getType": { + "get": { + "description": "The type provides a standardized definition for a schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getType/", + "operationId": "SoftLayer_Network_Storage_Schedule::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule/{SoftLayer_Network_Storage_ScheduleID}/getVolume": { + "get": { + "description": "The associated volume for a schedule.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule/getVolume/", + "operationId": "SoftLayer_Network_Storage_Schedule::getVolume", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule_Property_Type/getAllObjects": { + "get": { + "description": "Use this method to retrieve all network storage schedule property types. ", + "summary": "Returns all network storage schedule property types", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getAllObjects/", + "operationId": "SoftLayer_Network_Storage_Schedule_Property_Type::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule_Property_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Storage_Schedule_Property_Type/{SoftLayer_Network_Storage_Schedule_Property_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Storage_Schedule_Property_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getObject/", + "operationId": "SoftLayer_Network_Storage_Schedule_Property_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Schedule_Property_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/allowAccessToNetworkStorage": { + "post": { + "description": "This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control. ", + "summary": "Allow access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorage/", + "operationId": "SoftLayer_Network_Subnet::allowAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/allowAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Allow access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorageList/", + "operationId": "SoftLayer_Network_Subnet::allowAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/clearRoute": { + "get": { + "description": "This interface allows you to remove the route of your secondary subnets. The result will be a subnet that is no longer routed on the network. Remove the route of subnets you are not actively using, as it will make it easier to identify available subnets later. \n\n'''Important:''' When removing the route of ''Portable'' subnets, know that any subnet depending on an IP address provided by the Portable subnet will also have their routes removed! \n\nTo review what subnets are routed to IP addresses provided by a ''Portable'' subnet, you can utilize the following object mask: 'mask[ipAddresses[endpointSubnets]]'. Any subnet present in conjunction with ''endpointSubnets'' is a subnet which depends on the respective IP address. \n\nThe behavior of this interface is such that either true or false is returned. A result of false can be interpreted as the clear route request having already been completed. In contrast, a result of true means the subnet is currently routed and will be transitioned. This route change is asynchronous to the request. A response of true does not mean the subnet's route has changed, but simply that it will change. In order to monitor for the completion of the change, you may either attempt a clear route again until the result is false, or monitor one or more SoftLayer_Network_Subnet properties: subnetType, networkVlanId, and or endPointIpAddress to determine if routing of the subnet has been removed. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/clearRoute/", + "operationId": "SoftLayer_Network_Subnet::clearRoute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/createReverseDomainRecords": { + "get": { + "description": "Create the default PTR records for this subnet ", + "summary": "Create the default PTR records for this subnet", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/createReverseDomainRecords/", + "operationId": "SoftLayer_Network_Subnet::createReverseDomainRecords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Dns_Domain_Reverse" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/createSubnetRouteUpdateTransaction": { + "post": { + "description": "\n***DEPRECATED***\nThis endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies. Refer to it for more information. \n\nSimilarly, unroute requests are proxied to SoftLayer_Network_Subnet::clearRoute. ", + "summary": "create a new transaction to modify a subnet route.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/createSubnetRouteUpdateTransaction/", + "operationId": "SoftLayer_Network_Subnet::createSubnetRouteUpdateTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/createSwipTransaction": { + "get": { + "description": "\n***DEPRECATED***\nThis function is used to create a new SoftLayer SWIP transaction to register your RWHOIS data with ARIN. SWIP transactions can only be initiated on subnets that contain more than 8 IP addresses. ", + "summary": "create a SWIP transaction for a subnet", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/createSwipTransaction/", + "operationId": "SoftLayer_Network_Subnet::createSwipTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/editNote": { + "post": { + "description": "Edit the note for this subnet.", + "summary": "Edit the note for this subnet.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/editNote/", + "operationId": "SoftLayer_Network_Subnet::editNote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus": { + "get": { + "description": "\n***DEPRECATED***\nRetrieve a list of a SoftLayer customer's subnets along with their SWIP transaction statuses. This is a shortcut method that combines the SoftLayer_Network_Subnet retrieval methods along with [[object masks]] to retrieve their subnets' associated SWIP transactions as well. \n\nThis is a special function built for SoftLayer's use on the SWIP section of the customer portal, but may also be useful for API users looking for the same data. ", + "summary": "Retrieve a list of subnets along with their SWIP transaction statuses.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus/", + "operationId": "SoftLayer_Network_Subnet::findAllSubnetsAndActiveSwipTransactionStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getAttachedNetworkStorages": { + "post": { + "description": "Retrieves the combination of network storage devices and replicas this subnet has been granted access to. Allows for filtering based on storage device type. ", + "summary": "The network storage devices and replicas this subnet has been granted access to. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getAttachedNetworkStorages/", + "operationId": "SoftLayer_Network_Subnet::getAttachedNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getAvailableNetworkStorages": { + "post": { + "description": "Retrieves the combination of network storage devices and replicas this subnet has NOT been granted access to. Allows for filtering based on storage device type. ", + "summary": "The network storage devices and replicas this subnet has NOT been granted access to. Only devices within the same datacenter as this subnet will be returned. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getAvailableNetworkStorages/", + "operationId": "SoftLayer_Network_Subnet::getAvailableNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getIpAddressUsage": { + "get": { + "description": "Returns a list of IP address assignment details. Only assigned IP addresses are reported on. IP address assignments are presently only recorded and available for Primary Subnets. \n\nDetails on the resource assigned to each IP address will only be provided to users with access to the underlying resource. If the user cannot access the resource, a detail record will still be returned for the assignment but without any accompanying resource data. ", + "summary": "Retrieve IP address assignment details.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getIpAddressUsage/", + "operationId": "SoftLayer_Network_Subnet::getIpAddressUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress_UsageDetail" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getObject": { + "get": { + "description": "Retrieves a subnet by its id value. Only subnets assigned to your account are accessible. ", + "summary": "Retrieve a SoftLayer_Network_Subnet record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getObject/", + "operationId": "SoftLayer_Network_Subnet::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getReverseDomainRecords": { + "get": { + "description": "Retrieve all reverse DNS records associated with a subnet. ", + "summary": "Retrieve all reverse DNS records associated with a subnet.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getReverseDomainRecords/", + "operationId": "SoftLayer_Network_Subnet::getReverseDomainRecords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Dns_Domain" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getRoutableEndpointIpAddresses": { + "get": { + "description": "Returns IP addresses which may be used as routing endpoints for a given subnet. IP address which are currently the network, gateway, or broadcast address of a Secondary Portable subnet, are an address in a Secondary Static subnet, or if the address is not assigned to a resource when part of a Primary Subnet will not be available as a routing endpoint. ", + "summary": "Retrieve IP addresses which may be used as a routing endpoint from a subnet.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getRoutableEndpointIpAddresses/", + "operationId": "SoftLayer_Network_Subnet::getRoutableEndpointIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/getSubnetForIpAddress": { + "post": { + "description": "Retrieve the subnet associated with an IP address. You may only retrieve subnets assigned to your SoftLayer customer account. ", + "summary": "Retrieve an IP addresses's associated subnet.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getSubnetForIpAddress/", + "operationId": "SoftLayer_Network_Subnet::getSubnetForIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/removeAccessToNetworkStorageList": { + "post": { + "description": null, + "summary": "Removes access to multiple devices and replicas this subnet has been granted access to. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/removeAccessToNetworkStorageList/", + "operationId": "SoftLayer_Network_Subnet::removeAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/route": { + "post": { + "description": "This interface allows you to change the route of your secondary subnets. It accommodates a number of ways to identify your desired routing destination through the use of a 'type' and 'identifier'. Subnets may be routed as either Static or Portable, and that designation is dictated by the routing destination specified. \n\nStatic subnets have an ultimate routing destination of a single IP address but may not be routed to an existing subnet's IP address whose subnet is routed as a Static. Portable subnets have an ultimate routing destination of a VLAN. \n\nA subnet can be routed to any resource within the same \"routing region\" as the subnet itself. A subnet's routing region can be diverse but is usually limited to a single data center. \n\nThe following identifier 'type' values will result in Static routing:
  • SoftLayer_Network_Subnet_IpAddress
  • SoftLayer_Hardware_Server
  • SoftLayer_Virtual_Guest
\n\nThe following identifier 'type' values will result in Portable routing:
  • SoftLayer_Network_Vlan
\n\nFor each identifier type, one or more 'identifier' formats are possible. \n\n''SoftLayer_Network_Subnet_IpAddress'' will accept the following identifier formats:
  • 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.
\n\n''SoftLayer_Network_Vlan'' will accept the following identifier formats:
  • 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).
\n\n''SoftLayer_Hardware_Server'' will accept the following identifier formats:
  • 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.
\n\n''SoftLayer_Virtual_Guest'' will accept the following identifier formats:
  • 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.
\n\nThe routing destination result of specifying a SoftLayer_Hardware_Server or SoftLayer_Virtual_Guest type will be the primary IP address of the server for the same network segment the subnet is on. Thus, a public subnet will be routed to the server's public, primary IP address. Additionally, this IP address resolution will match the subnet's IP version; routing a IPv6 subnet to a server will result in selection of the primary IPv6 address of the respective network segment, if available. \n\nSubnets may only be routed to the IP version they themselves represent. That means an IPv4 subnet can only be routed to IPv4 addresses. Any type/identifier combination that resolves to an IP address must be able to locate an IP address of the same version as the subnet being routed. \n\nWhen routing to an IP address on a Primary subnet, only those addresses actively assigned to resources may be targeted. Additionally, the network, gateway, or broadcast address of any Portable subnet may not be a routing destination. For some VLANs utilizing the HSRP redundancy strategy, there are additional addresses which cannot be a route destination. \n\nWhen routing a subnet that is already routed, note that the subnet first has its route removed; this procedure is the same as what will occur when using SoftLayer_Network_Subnet::clearRoute. Special consideration should be made for subnets routed as Portable. Please refer to the documentation for SoftLayer_Network_Subnet::clearRoute for details. \n\nThe behavior of this interface is such that either true or false is returned. A response of false indicates the route request would not result in the route of the subnet changing; attempts to route the subnet to the same destination, even if identified by differing means, will result in no changes. A result of false can be interpreted as the route request having already been completed. In contrast, a result of true means the requested destination is different from the current destination and the subnet's routing will be transitioned. This route change is asynchronous to the request. A response of true does not mean the subnet's route has changed, but simply that it will change. In order to monitor for the completion of the change, you may either attempt a route change again until the result is false, or monitor one or more SoftLayer_Network_Subnet properties: subnetType, networkVlanId, and or endPointIpAddress to determine if routing of the subnet has become the desired route destination. \n\nUse of this operation is limited to a single active request per subnet. If a previous route request is not yet complete, a \"not ready\" message will be returned upon subsequent requests. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/route/", + "operationId": "SoftLayer_Network_Subnet::route", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/setTags": { + "post": { + "description": "Tag a subnet by passing in one or more tags separated by a comma. Any existing tags you wish to keep should be included in the set of tags, as any missing tags will be removed. To remove all tags from the subnet, send an empty string. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/setTags/", + "operationId": "SoftLayer_Network_Subnet::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getAccount/", + "operationId": "SoftLayer_Network_Subnet::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getActiveRegistration": { + "get": { + "description": "The active regional internet registration for this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getActiveRegistration/", + "operationId": "SoftLayer_Network_Subnet::getActiveRegistration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getActiveSwipTransaction": { + "get": { + "description": "DEPRECATED", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getActiveSwipTransaction/", + "operationId": "SoftLayer_Network_Subnet::getActiveSwipTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Swip_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getActiveTransaction": { + "get": { + "description": "DEPRECATED", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getActiveTransaction/", + "operationId": "SoftLayer_Network_Subnet::getActiveTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getAddressSpace": { + "get": { + "description": "The classifier of IP addresses this subnet represents, generally PUBLIC or PRIVATE. This does not necessarily correlate with the network on which the subnet is used.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getAddressSpace/", + "operationId": "SoftLayer_Network_Subnet::getAddressSpace", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getAllowedHost": { + "get": { + "description": "The link from this subnet to network storage devices supporting access control lists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getAllowedHost/", + "operationId": "SoftLayer_Network_Subnet::getAllowedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getAllowedNetworkStorage": { + "get": { + "description": "The network storage devices this subnet has been granted access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorage/", + "operationId": "SoftLayer_Network_Subnet::getAllowedNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getAllowedNetworkStorageReplicas": { + "get": { + "description": "The network storage device replicas this subnet has been granted access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorageReplicas/", + "operationId": "SoftLayer_Network_Subnet::getAllowedNetworkStorageReplicas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getBillingItem": { + "get": { + "description": "The active billing item for this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getBillingItem/", + "operationId": "SoftLayer_Network_Subnet::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getBoundDescendants": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getBoundDescendants/", + "operationId": "SoftLayer_Network_Subnet::getBoundDescendants", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getBoundRouterFlag": { + "get": { + "description": "Indicates whether this subnet is associated to a network router and is routable on the network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getBoundRouterFlag/", + "operationId": "SoftLayer_Network_Subnet::getBoundRouterFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getBoundRouters": { + "get": { + "description": "The list of network routers that this subnet is directly associated with, defining where this subnet may be routed on the network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getBoundRouters/", + "operationId": "SoftLayer_Network_Subnet::getBoundRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getChildren": { + "get": { + "description": "The immediate descendants of this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getChildren/", + "operationId": "SoftLayer_Network_Subnet::getChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getDatacenter": { + "get": { + "description": "The datacenter this subnet is primarily associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getDatacenter/", + "operationId": "SoftLayer_Network_Subnet::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Datacenter" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getDescendants": { + "get": { + "description": "The descendants of this subnet, including all parents and children.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getDescendants/", + "operationId": "SoftLayer_Network_Subnet::getDescendants", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getDisplayLabel": { + "get": { + "description": "[DEPRECATED] The description of this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getDisplayLabel/", + "operationId": "SoftLayer_Network_Subnet::getDisplayLabel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getEndPointIpAddress": { + "get": { + "description": "The IP address target of this statically routed subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getEndPointIpAddress/", + "operationId": "SoftLayer_Network_Subnet::getEndPointIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getGlobalIpRecord": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getGlobalIpRecord/", + "operationId": "SoftLayer_Network_Subnet::getGlobalIpRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress_Global" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getHardware": { + "get": { + "description": "The Bare Metal devices which have been assigned a primary IP address from this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getHardware/", + "operationId": "SoftLayer_Network_Subnet::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getIpAddresses": { + "get": { + "description": "The IP address records belonging to this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getIpAddresses/", + "operationId": "SoftLayer_Network_Subnet::getIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getNetworkComponentFirewall": { + "get": { + "description": "The hardware firewall associated to this subnet via access control list.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getNetworkComponentFirewall/", + "operationId": "SoftLayer_Network_Subnet::getNetworkComponentFirewall", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getNetworkProtectionAddresses": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getNetworkProtectionAddresses/", + "operationId": "SoftLayer_Network_Subnet::getNetworkProtectionAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Protection_Address" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getNetworkTunnelContexts": { + "get": { + "description": "The IPSec VPN tunnels associated to this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getNetworkTunnelContexts/", + "operationId": "SoftLayer_Network_Subnet::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_Network_Subnet/{SoftLayer_Network_SubnetID}/getNetworkVlan": { + "get": { + "description": "The VLAN this subnet is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getNetworkVlan/", + "operationId": "SoftLayer_Network_Subnet::getNetworkVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getPodName": { + "get": { + "description": "The pod in which this subnet is currently routed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getPodName/", + "operationId": "SoftLayer_Network_Subnet::getPodName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getProtectedIpAddresses": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getProtectedIpAddresses/", + "operationId": "SoftLayer_Network_Subnet::getProtectedIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getRegionalInternetRegistry": { + "get": { + "description": "The RIR which is authoritative over the network in which this subnet resides.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getRegionalInternetRegistry/", + "operationId": "SoftLayer_Network_Subnet::getRegionalInternetRegistry", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Regional_Internet_Registry" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getRegistrations": { + "get": { + "description": "The regional internet registrations that have been created for this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getRegistrations/", + "operationId": "SoftLayer_Network_Subnet::getRegistrations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getReverseDomain": { + "get": { + "description": "The reverse DNS domain associated with this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getReverseDomain/", + "operationId": "SoftLayer_Network_Subnet::getReverseDomain", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Dns_Domain" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getRoleKeyName": { + "get": { + "description": "The role identifier that this subnet is participating in. Roles dictate how a subnet may be used.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getRoleKeyName/", + "operationId": "SoftLayer_Network_Subnet::getRoleKeyName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getRoleName": { + "get": { + "description": "The name of the role the subnet is within. Roles dictate how a subnet may be used.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getRoleName/", + "operationId": "SoftLayer_Network_Subnet::getRoleName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getRoutingTypeKeyName": { + "get": { + "description": "The product and route classifier for this routed subnet, with the following values: PRIMARY, SECONDARY, STATIC_TO_IP, GLOBAL_IP, IPSEC_STATIC_NAT.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getRoutingTypeKeyName/", + "operationId": "SoftLayer_Network_Subnet::getRoutingTypeKeyName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getRoutingTypeName": { + "get": { + "description": "The description of the product and route classifier for this routed subnet, with the following values: Primary, Portable, Static, Global, IPSec Static NAT.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getRoutingTypeName/", + "operationId": "SoftLayer_Network_Subnet::getRoutingTypeName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getSwipTransaction": { + "get": { + "description": "DEPRECATED", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getSwipTransaction/", + "operationId": "SoftLayer_Network_Subnet::getSwipTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Swip_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getTagReferences": { + "get": { + "description": "The tags associated to this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getTagReferences/", + "operationId": "SoftLayer_Network_Subnet::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getUnboundDescendants": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getUnboundDescendants/", + "operationId": "SoftLayer_Network_Subnet::getUnboundDescendants", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getUtilizedIpAddressCount": { + "get": { + "description": "The total number of utilized IP addresses on this subnet. The primary consumer of IP addresses are compute resources, which can consume more than one address. This value is only supported for primary subnets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getUtilizedIpAddressCount/", + "operationId": "SoftLayer_Network_Subnet::getUtilizedIpAddressCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getVirtualGuests": { + "get": { + "description": "The Virtual Server devices which have been assigned a primary IP address from this subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/getVirtualGuests/", + "operationId": "SoftLayer_Network_Subnet::getVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/allowAccessToNetworkStorage": { + "post": { + "description": "This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control. ", + "summary": "Allow access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorage/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::allowAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/allowAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Allow access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorageList/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::allowAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/editObject": { + "post": { + "description": "Edit a subnet IP address. ", + "summary": "Edit the object by passing in a modified instance of the object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/editObject/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/editObjects": { + "post": { + "description": "This function is used to edit multiple objects at the same time. ", + "summary": "Edit multiple objects by passing in modified instances of the object.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/editObjects/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::editObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/findByIpv4Address": { + "post": { + "description": "Search for an IP address record by IPv4 address.", + "summary": "Search for an IP address record by IPv4 address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/findByIpv4Address/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::findByIpv4Address", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/findUsage": { + "get": { + "description": "Returns a list of IP address assignment details. Only assigned IP addresses are reported on. IP address assignments are presently only recorded and available for Primary Subnets and their IP addresses. \n\nDetails on the resource assigned to each IP address will only be provided to users with access to the underlying resource. If the user cannot access the resource, a detail record will still be returned for the assignment but without any accompanying resource data. \n\nCallers may provide a SoftLayer_Network_Subnet_IpAddress object filter as search criteria. A result limit and offset may also be provided. A maximum of 1024 results can be retrieved at a time. ", + "summary": "Search for IP address assignment details.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/findUsage/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::findUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress_UsageDetail" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getAttachedNetworkStorages": { + "post": { + "description": "This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Network_Subnet_IpAddress. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getAttachedNetworkStorages/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getAttachedNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getAvailableNetworkStorages": { + "post": { + "description": "This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Network_Subnet_IpAddress. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getAvailableNetworkStorages/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getAvailableNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/getByIpAddress": { + "post": { + "description": "Search for an IP address record by IP address.", + "summary": "Search for an IP address record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getByIpAddress/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Network_Subnet_IpAddress object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_IpAddress service. You can only retrieve the IP address whose subnet is associated with a VLAN that is associated with the account that your portal user is assigned to. ", + "summary": "Retrieve a SoftLayer_Network_Subnet_IpAddress record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getObject/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/removeAccessToNetworkStorageList": { + "post": { + "description": "This method is used to remove access to multiple SoftLayer_Network_Storage volumes ", + "summary": "Remove access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/removeAccessToNetworkStorageList/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::removeAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getAllowedHost": { + "get": { + "description": "The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedHost/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getAllowedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getAllowedNetworkStorage": { + "get": { + "description": "The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorage/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getAllowedNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getAllowedNetworkStorageReplicas": { + "get": { + "description": "The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorageReplicas/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getAllowedNetworkStorageReplicas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getApplicationDeliveryController": { + "get": { + "description": "The application delivery controller using this address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getApplicationDeliveryController/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getApplicationDeliveryController", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getContextTunnelTranslations": { + "get": { + "description": "An IPSec network tunnel's address translations. These translations use a SoftLayer ip address from an assigned static NAT subnet to deliver the packets to the remote (customer) destination.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getContextTunnelTranslations/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getContextTunnelTranslations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Tunnel_Module_Context_Address_Translation" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getEndpointSubnets": { + "get": { + "description": "All the subnets routed to an IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getEndpointSubnets/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getEndpointSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getGuestNetworkComponent": { + "get": { + "description": "A network component that is statically routed to an IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponent/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getGuestNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getGuestNetworkComponentBinding": { + "get": { + "description": "A network component that is statically routed to an IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponentBinding/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getGuestNetworkComponentBinding", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getHardware": { + "get": { + "description": "A server that this IP address is routed to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getHardware/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getNetworkComponent": { + "get": { + "description": "A network component that is statically routed to an IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getNetworkComponent/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getPrivateNetworkGateway": { + "get": { + "description": "The network gateway appliance using this address as the private IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getPrivateNetworkGateway/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getPrivateNetworkGateway", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getProtectionAddress": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getProtectionAddress/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getProtectionAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Protection_Address" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getPublicNetworkGateway": { + "get": { + "description": "The network gateway appliance using this address as the public IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getPublicNetworkGateway/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getPublicNetworkGateway", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getRemoteManagementNetworkComponent": { + "get": { + "description": "An IPMI-based management network component of the IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getRemoteManagementNetworkComponent/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getRemoteManagementNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getSubnet": { + "get": { + "description": "An IP address' associated subnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getSubnet/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getSubnet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getSyslogEventsOneDay": { + "get": { + "description": "All events for this IP address stored in the datacenter syslogs from the last 24 hours", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsOneDay/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getSyslogEventsOneDay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getSyslogEventsSevenDays": { + "get": { + "description": "All events for this IP address stored in the datacenter syslogs from the last 7 days", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsSevenDays/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getSyslogEventsSevenDays", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getTopTenSyslogEventsByDestinationPortOneDay": { + "get": { + "description": "Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortOneDay/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsByDestinationPortOneDay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getTopTenSyslogEventsByDestinationPortSevenDays": { + "get": { + "description": "Top Ten network datacenter syslog events, grouped by destination port, for the last 7 days", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortSevenDays/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsByDestinationPortSevenDays", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getTopTenSyslogEventsByProtocolsOneDay": { + "get": { + "description": "Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsOneDay/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsByProtocolsOneDay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getTopTenSyslogEventsByProtocolsSevenDays": { + "get": { + "description": "Top Ten network datacenter syslog events, grouped by source port, for the last 7 days", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsSevenDays/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsByProtocolsSevenDays", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getTopTenSyslogEventsBySourceIpOneDay": { + "get": { + "description": "Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpOneDay/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsBySourceIpOneDay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getTopTenSyslogEventsBySourceIpSevenDays": { + "get": { + "description": "Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpSevenDays/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsBySourceIpSevenDays", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getTopTenSyslogEventsBySourcePortOneDay": { + "get": { + "description": "Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortOneDay/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsBySourcePortOneDay", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getTopTenSyslogEventsBySourcePortSevenDays": { + "get": { + "description": "Top Ten network datacenter syslog events, grouped by source port, for the last 7 days", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortSevenDays/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getTopTenSyslogEventsBySourcePortSevenDays", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getVirtualGuest": { + "get": { + "description": "A virtual guest that this IP address is routed to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualGuest/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress/{SoftLayer_Network_Subnet_IpAddressID}/getVirtualLicenses": { + "get": { + "description": "Virtual licenses allocated for an IP Address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualLicenses/", + "operationId": "SoftLayer_Network_Subnet_IpAddress::getVirtualLicenses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_VirtualLicense" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress_Global/{SoftLayer_Network_Subnet_IpAddress_GlobalID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Subnet_IpAddress_Global record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getObject/", + "operationId": "SoftLayer_Network_Subnet_IpAddress_Global::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress_Global" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress_Global/{SoftLayer_Network_Subnet_IpAddress_GlobalID}/route": { + "post": { + "description": "\n***DEPRECATED***\nThis endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies. Refer to it for more information. \n\nSimilarly, unroute requests are proxied to SoftLayer_Network_Subnet::clearRoute. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/route/", + "operationId": "SoftLayer_Network_Subnet_IpAddress_Global::route", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress_Global/{SoftLayer_Network_Subnet_IpAddress_GlobalID}/unroute": { + "get": { + "description": "\n***DEPRECATED***\nThis endpoint is deprecated in favor of SoftLayer_Network_Subnet::clearRoute, to which this endpoint now proxies. Refer to it for more information. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/unroute/", + "operationId": "SoftLayer_Network_Subnet_IpAddress_Global::unroute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress_Global/{SoftLayer_Network_Subnet_IpAddress_GlobalID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getAccount/", + "operationId": "SoftLayer_Network_Subnet_IpAddress_Global::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress_Global/{SoftLayer_Network_Subnet_IpAddress_GlobalID}/getActiveTransaction": { + "get": { + "description": "DEPRECATED", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getActiveTransaction/", + "operationId": "SoftLayer_Network_Subnet_IpAddress_Global::getActiveTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress_Global/{SoftLayer_Network_Subnet_IpAddress_GlobalID}/getBillingItem": { + "get": { + "description": "The billing item for this Global IP.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getBillingItem/", + "operationId": "SoftLayer_Network_Subnet_IpAddress_Global::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress_Global/{SoftLayer_Network_Subnet_IpAddress_GlobalID}/getDestinationIpAddress": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getDestinationIpAddress/", + "operationId": "SoftLayer_Network_Subnet_IpAddress_Global::getDestinationIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_IpAddress_Global/{SoftLayer_Network_Subnet_IpAddress_GlobalID}/getIpAddress": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getIpAddress/", + "operationId": "SoftLayer_Network_Subnet_IpAddress_Global::getIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/clearRegistration": { + "get": { + "description": "The subnet registration service has been deprecated. \n\nThis method will initiate the removal of a subnet registration. ", + "summary": "[Deprecated] Clear an existing registration", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration/", + "operationId": "SoftLayer_Network_Subnet_Registration::clearRegistration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/createObject": { + "post": { + "description": "The subnet registration service has been deprecated. \n\nCreate registration with a global registrar to associate an assigned subnet with the provided contact details. \n\nContact information is provided in the form of a [[SoftLayer_Account_Regional_Registry_Detail|person detail record]], which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [[SoftLayer_Account_Regional_Registry_Detail|person detail record]]. \n\nThe same applies to [[SoftLayer_Account_Regional_Registry_Detail|network detail records]], though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration. \n\nA template containing the following properties will create a subnet registration: \n\n\n* networkIdentifier\n* cidr\n* detailReferences\n\n\n``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects. ", + "summary": "[Deprecated] Create a new subnet registration", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/createObject/", + "operationId": "SoftLayer_Network_Subnet_Registration::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/createObjects": { + "post": { + "description": "The subnet registration service has been deprecated. \n\nCreate registrations with respective registrars to associate multiple assigned subnets with the provided contact details. ", + "summary": "[Deprecated] Create registrations for multiple subnets", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/createObjects/", + "operationId": "SoftLayer_Network_Subnet_Registration::createObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/editObject": { + "post": { + "description": "The subnet registration service has been deprecated. \n\nThis method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [[SoftLayer_Network_Subnet_Registration::createObject|createObject]]. ", + "summary": "[Deprecated] Edit an existing registration object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/editObject/", + "operationId": "SoftLayer_Network_Subnet_Registration::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails": { + "post": { + "description": "The subnet registration service has been deprecated. \n\nThis method modifies a single registration by modifying the current [[SoftLayer_Network_Subnet_Registration_Details]] objects that are linked to that registration. ", + "summary": "[Deprecated] Modify the link between a [[SoftLayer_Network_Subnet_Registration]] object and two [[SoftLayer_Account_Regional_Registry_Detail]] objects simultaneously. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails/", + "operationId": "SoftLayer_Network_Subnet_Registration::editRegistrationAttachedDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Subnet_Registration record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/getObject/", + "operationId": "SoftLayer_Network_Subnet_Registration::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getAccount": { + "get": { + "description": "[Deprecated] The account that this registration belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/getAccount/", + "operationId": "SoftLayer_Network_Subnet_Registration::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getDetailReferences": { + "get": { + "description": "[Deprecated] The cross-reference records that tie the [[SoftLayer_Account_Regional_Registry_Detail]] objects to the registration object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences/", + "operationId": "SoftLayer_Network_Subnet_Registration::getDetailReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration_Details" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getEvents": { + "get": { + "description": "[Deprecated] The related registration events.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/getEvents/", + "operationId": "SoftLayer_Network_Subnet_Registration::getEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getNetworkDetail": { + "get": { + "description": "[Deprecated] The \"network\" detail object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail/", + "operationId": "SoftLayer_Network_Subnet_Registration::getNetworkDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getPersonDetail": { + "get": { + "description": "[Deprecated] The \"person\" detail object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail/", + "operationId": "SoftLayer_Network_Subnet_Registration::getPersonDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getRegionalInternetRegistry": { + "get": { + "description": "[Deprecated] The related Regional Internet Registry.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry/", + "operationId": "SoftLayer_Network_Subnet_Registration::getRegionalInternetRegistry", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Regional_Internet_Registry" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getRegionalInternetRegistryHandle": { + "get": { + "description": "[Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle/", + "operationId": "SoftLayer_Network_Subnet_Registration::getRegionalInternetRegistryHandle", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Rwhois_Handle" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getStatus": { + "get": { + "description": "[Deprecated] The status of this registration.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/getStatus/", + "operationId": "SoftLayer_Network_Subnet_Registration::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getSubnet": { + "get": { + "description": "[Deprecated] The subnet that this registration pertains to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet/", + "operationId": "SoftLayer_Network_Subnet_Registration::getSubnet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration_Details/createObject": { + "post": { + "description": "The subnet registration details service has been deprecated. \n\n This method will create a new SoftLayer_Network_Subnet_Registration_Details object. \n\nInput - [[SoftLayer_Network_Subnet_Registration_Details (type)|SoftLayer_Network_Subnet_Registration_Details]]
  • detailId
    The numeric ID of the [[SoftLayer_Account_Regional_Registry_Detail|detail]] object to relate.
    • Required
    • Type - integer
  • registrationId
    The numeric ID of the [[SoftLayer_Network_Subnet_Registration|registration]] object to relate.
    • Required
    • Type - integer
", + "summary": "[Deprecated] Create a new association between a [[SoftLayer_Network_Subnet_Registration]] object and a [[SoftLayer_Account_Regional_Registry_Detail]] object. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject/", + "operationId": "SoftLayer_Network_Subnet_Registration_Details::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration_Details" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration_Details/{SoftLayer_Network_Subnet_Registration_DetailsID}/deleteObject": { + "get": { + "description": "The subnet registration details service has been deprecated. \n\nThis method will delete an existing SoftLayer_Account_Regional_Registry_Detail object. ", + "summary": "[Deprecated] Remove an existing association between a [[SoftLayer_Network_Subnet_Registration]] object and a [[SoftLayer_Account_Regional_Registry_Detail]] object. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject/", + "operationId": "SoftLayer_Network_Subnet_Registration_Details::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration_Details/{SoftLayer_Network_Subnet_Registration_DetailsID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Subnet_Registration_Details record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration_Details/getObject/", + "operationId": "SoftLayer_Network_Subnet_Registration_Details::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration_Details" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration_Details/{SoftLayer_Network_Subnet_Registration_DetailsID}/getDetail": { + "get": { + "description": "[Deprecated] The related [[SoftLayer_Account_Regional_Registry_Detail|detail object]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail/", + "operationId": "SoftLayer_Network_Subnet_Registration_Details::getDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Regional_Registry_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration_Details/{SoftLayer_Network_Subnet_Registration_DetailsID}/getRegistration": { + "get": { + "description": "[Deprecated] The related [[SoftLayer_Network_Subnet_Registration|registration object]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration/", + "operationId": "SoftLayer_Network_Subnet_Registration_Details::getRegistration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration_Status/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration_Status/getAllObjects/", + "operationId": "SoftLayer_Network_Subnet_Registration_Status::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration_Status" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Registration_Status/{SoftLayer_Network_Subnet_Registration_StatusID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Subnet_Registration_Status record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Registration_Status/getObject/", + "operationId": "SoftLayer_Network_Subnet_Registration_Status::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Registration_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Rwhois_Data/{SoftLayer_Network_Subnet_Rwhois_DataID}/editObject": { + "post": { + "description": "Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable.", + "summary": "Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable. The fields are as follows: \n* companyName\n* firstName\n* lastName\n* city\n* country\n* postalCode\n* abuseEmail\n* address1", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/editObject/", + "operationId": "SoftLayer_Network_Subnet_Rwhois_Data::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Rwhois_Data/{SoftLayer_Network_Subnet_Rwhois_DataID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Network_Subnet_Rwhois_Data object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_Rwhois_Data service. \n\nThe best way to get Rwhois Data for an account is through getRhwoisData on the Account service. ", + "summary": "Retrieve a SoftLayer_Network_Subnet_Rwhois_Data record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getObject/", + "operationId": "SoftLayer_Network_Subnet_Rwhois_Data::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Rwhois_Data" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Rwhois_Data/{SoftLayer_Network_Subnet_Rwhois_DataID}/getAccount": { + "get": { + "description": "The SoftLayer customer account associated with this reverse WHOIS data.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getAccount/", + "operationId": "SoftLayer_Network_Subnet_Rwhois_Data::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions": { + "get": { + "description": "\n**DEPRECATED**\nThis function will return an array of SoftLayer_Network_Subnet_Swip_Transaction objects, one for each SWIP that is currently in transaction with ARIN. This includes all swip registrations, swip removal requests, and SWIP objects that are currently OK. ", + "summary": "returns SWIP transaction objects that are currently in transaction with ARIN.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions/", + "operationId": "SoftLayer_Network_Subnet_Swip_Transaction::findMyTransactions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Swip_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Swip_Transaction/{SoftLayer_Network_Subnet_Swip_TransactionID}/getObject": { + "get": { + "description": "\n**DEPRECATED**\ngetObject retrieves the SoftLayer_Network_Subnet_Swip_Transaction object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_Swip_transaction service. You can only retrieve Swip transactions tied to the account. ", + "summary": "Retrieve a SoftLayer_Network_Subnet_Swip_Transaction record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getObject/", + "operationId": "SoftLayer_Network_Subnet_Swip_Transaction::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_Swip_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips": { + "get": { + "description": "\n**DEPRECATED**\nThis method finds all subnets attached to your account that are in OK status and starts \"DELETE\" transactions with ARIN, allowing you to remove your SWIP registration information. ", + "summary": "Removes registration information from ARIN for all your subnets", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips/", + "operationId": "SoftLayer_Network_Subnet_Swip_Transaction::removeAllSubnetSwips", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Swip_Transaction/{SoftLayer_Network_Subnet_Swip_TransactionID}/removeSwipData": { + "get": { + "description": "\n**DEPRECATED**\nThis function, when called on an instantiated SWIP transaction, will allow you to start a \"DELETE\" transaction with ARIN, allowing you to remove your SWIP registration information. ", + "summary": "Deletes registration information from ARIN for a single subnet", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeSwipData/", + "operationId": "SoftLayer_Network_Subnet_Swip_Transaction::removeSwipData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Swip_Transaction/{SoftLayer_Network_Subnet_Swip_TransactionID}/resendSwipData": { + "get": { + "description": "\n**DEPRECATED**\nThis function will allow you to update ARIN's registration data for a subnet to your current RWHOIS data. ", + "summary": "Sends updated RWHOIS information to ARIN for a single subnet.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/resendSwipData/", + "operationId": "SoftLayer_Network_Subnet_Swip_Transaction::resendSwipData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets": { + "get": { + "description": "\n**DEPRECATED**\nswipAllSubnets finds all subnets attached to your account and attempts to create a SWIP transaction for all subnets that do not already have a SWIP transaction in progress. ", + "summary": "create SWIP transactions for all subnets that do not already have a SWIP transaction in progress.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets/", + "operationId": "SoftLayer_Network_Subnet_Swip_Transaction::swipAllSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips": { + "get": { + "description": "\n**DEPRECATED**\nThis method finds all subnets attached to your account that are in \"OK\" status and updates their data with ARIN. Use this function after you have updated your RWHOIS data if you want to keep SWIP up to date. ", + "summary": "Update all subnets on the account with an \"OK\" status.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips/", + "operationId": "SoftLayer_Network_Subnet_Swip_Transaction::updateAllSubnetSwips", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Swip_Transaction/{SoftLayer_Network_Subnet_Swip_TransactionID}/getAccount": { + "get": { + "description": "The Account whose RWHOIS data was used to SWIP this subnet", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getAccount/", + "operationId": "SoftLayer_Network_Subnet_Swip_Transaction::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Subnet_Swip_Transaction/{SoftLayer_Network_Subnet_Swip_TransactionID}/getSubnet": { + "get": { + "description": "The subnet that this SWIP transaction was created for.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getSubnet/", + "operationId": "SoftLayer_Network_Subnet_Swip_Transaction::getSubnet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/addCustomerSubnetToNetworkTunnel": { + "post": { + "description": "Associates a remote subnet to the network tunnel. When a remote subnet is associated, a network tunnel will allow the customer (remote) network to communicate with the private and service subnets on the SoftLayer network which are on the other end of this network tunnel. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for the association described above to take effect. ", + "summary": "Associate a remote subnet to a network tunnel", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/addCustomerSubnetToNetworkTunnel/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::addCustomerSubnetToNetworkTunnel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/addPrivateSubnetToNetworkTunnel": { + "post": { + "description": "Associates a private subnet to the network tunnel. When a private subnet is associated, the network tunnel will allow the customer (remote) network to access the private subnet. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for the association described above to take effect. ", + "summary": "Associate a private subnet to a network tunnel.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/addPrivateSubnetToNetworkTunnel/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::addPrivateSubnetToNetworkTunnel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/addServiceSubnetToNetworkTunnel": { + "post": { + "description": "Associates a service subnet to the network tunnel. When a service subnet is associated, a network tunnel will allow the customer (remote) network to communicate with the private and service subnets on the SoftLayer network which are on the other end of this network tunnel. Service subnets provide access to SoftLayer services such as the customer management portal and the SoftLayer API. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for the association described above to take effect. ", + "summary": "Associate a service subnet to a network tunnel.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/addServiceSubnetToNetworkTunnel/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::addServiceSubnetToNetworkTunnel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/applyConfigurationsToDevice": { + "get": { + "description": "An asynchronous task will be created to apply the IPSec network tunnel's configuration to network devices. During this time, an IPSec network tunnel cannot be modified in anyway. Only one network tunnel configuration task can be created at a time. If a task has already been created and has not completed, a new task cannot be created. ", + "summary": "Apply current configuration settings to the network device", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/applyConfigurationsToDevice/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::applyConfigurationsToDevice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/createAddressTranslation": { + "post": { + "description": "Create an address translation for a network tunnel. \n\nTo create an address translation, ip addresses from an assigned /30 static route subnet are used. Address translations deliver packets to a destination ip address that is on a customer (remote) subnet. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be created. ", + "summary": "Create an address translation for a network tunnel", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslation/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::createAddressTranslation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Tunnel_Module_Context_Address_Translation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/createAddressTranslations": { + "post": { + "description": "This has the same functionality as the SoftLayer_Network_Tunnel_Module_Context::createAddressTranslation. However, it allows multiple translations to be passed in for creation. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for the address translations to be created. ", + "summary": "Create address translations for a network tunnel", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslations/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::createAddressTranslations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Tunnel_Module_Context_Address_Translation" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/deleteAddressTranslation": { + "post": { + "description": "Remove an existing address translation from a network tunnel. \n\nAddress translations deliver packets to a destination ip address that is on a customer subnet (remote). \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be deleted. ", + "summary": "Delete an address translation from a network tunnel", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/deleteAddressTranslation/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::deleteAddressTranslation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/downloadAddressTranslationConfigurations": { + "get": { + "description": "Provides all of the address translation configurations for an IPSec VPN tunnel in a text file ", + "summary": "Returns IPSec VPN tunnel address translation configurations in a text file.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadAddressTranslationConfigurations/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::downloadAddressTranslationConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/downloadParameterConfigurations": { + "get": { + "description": "Provides all of the configurations for an IPSec VPN network tunnel in a text file ", + "summary": "Returns IPSec VPN tunnel configurations in a text file.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadParameterConfigurations/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::downloadParameterConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Utility_File_Entity" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/editAddressTranslation": { + "post": { + "description": "Edit name, source (SoftLayer IP) ip address and/or destination (Customer IP) ip address for an existing address translation for a network tunnel. \n\nAddress translations deliver packets to a destination ip address that is on a customer (remote) subnet. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be created. ", + "summary": "Edit an address translation for a network tunnel", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslation/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::editAddressTranslation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Tunnel_Module_Context_Address_Translation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/editAddressTranslations": { + "post": { + "description": "Edit name, source (SoftLayer IP) ip address and/or destination (Customer IP) ip address for existing address translations for a network tunnel. \n\nAddress translations deliver packets to a destination ip address that is on a customer (remote) subnet. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be modified. ", + "summary": "Edit address translations for a network tunnel", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslations/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::editAddressTranslations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Tunnel_Module_Context_Address_Translation" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/editObject": { + "post": { + "description": "Negotiation parameters for both phases one and two are editable. Here are the phase one and two parameters that can modified: \n\n\n*Phase One\n**Authentication\n***Default value is set to MD5.\n***Valid Options are: MD5, SHA1, SHA256.\n**Encryption\n***Default value is set to 3DES.\n***Valid Options are: DES, 3DES, AES128, AES192, AES256.\n**Diffie-Hellman Group\n***Default value is set to 2.\n***Valid Options are: 0 (None), 1, 2, 5.\n**Keylife\n***Default value is set to 3600.\n***Limits are: MIN = 120, MAX = 172800\n**Preshared Key\n*Phase Two\n**Authentication\n***Default value is set to MD5.\n***Valid Options are: MD5, SHA1, SHA256.\n**Encryption\n***Default value is set to 3DES.\n***Valid Options are: DES, 3DES, AES128, AES192, AES256.\n**Diffie-Hellman Group\n***Default value is set to 2.\n***Valid Options are: 0 (None), 1, 2, 5.\n**Keylife\n***Default value is set to 28800.\n***Limits are: MIN = 120, MAX = 172800\n**Perfect Forward Secrecy\n***Valid Options are: Off = 0, On = 1.\n***NOTE: If perfect forward secrecy is turned On (set to 1), then a phase 2 diffie-hellman group is required.\n\n\nThe remote peer address for the network tunnel may also be modified if needed. Invalid options will not be accepted and will cause an exception to be thrown. There are properties that provide valid options and limits for each negotiation parameter. Those properties are as follows: \n* encryptionDefault\n* encryptionOptions\n* authenticationDefault\n* authenticationOptions\n* diffieHellmanGroupDefault\n* diffieHellmanGroupOptions\n* phaseOneKeylifeDefault\n* phaseTwoKeylifeDefault\n* keylifeLimits\n\n\nConfigurations cannot be modified if a network tunnel's requires complex manual setups/configuration modifications by the SoftLayer Network department. If the former is required, the configurations for the network tunnel will be locked until the manual configurations are complete. A network tunnel's configurations are applied via a transaction. If a network tunnel configuration change transaction is currently running, the network tunnel's setting cannot be modified until the running transaction completes. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for the modifications made to take effect. ", + "summary": "Edit various settings for a network tunnel.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/editObject/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getAddressTranslationConfigurations": { + "get": { + "description": "The address translations will be returned. All the translations will be formatted so that the configurations can be copied into a host file. \n\nFormat: \n\n{address translation SoftLayer IP Address} {address translation name} ", + "summary": "Build and returns IPsec VPN tunnel address translation configurations", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslationConfigurations/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getAddressTranslationConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/getAuthenticationDefault": { + "get": { + "description": "The default authentication type used for both phases of the negotiation process. The default value is set to MD5. ", + "summary": "Returns the authentication default.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationDefault/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getAuthenticationDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/getAuthenticationOptions": { + "get": { + "description": "Authentication options available for both phases of the negotiation process. \n\nThe authentication options are as follows: \n* MD5\n* SHA1\n* SHA256", + "summary": "Returns the authentication options.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationOptions/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getAuthenticationOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupDefault": { + "get": { + "description": "The default Diffie-Hellman group used for both phases of the negotiation process. The default value is set to 2. ", + "summary": "Returns the diffie hellman group default.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupDefault/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getDiffieHellmanGroupDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupOptions": { + "get": { + "description": "The Diffie-Hellman group options used for both phases of the negotiation process. \n\nThe diffie-hellman group options are as follows: \n* 0 (None)\n* 1\n* 2\n* 5", + "summary": "Returns the diffie-hellman group options.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupOptions/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getDiffieHellmanGroupOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/getEncryptionDefault": { + "get": { + "description": "The default encryption type used for both phases of the negotiation process. The default value is set to 3DES. ", + "summary": "Returns the encryption default.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionDefault/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getEncryptionDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/getEncryptionOptions": { + "get": { + "description": "Encryption options available for both phases of the negotiation process. \n\nThe valid encryption options are as follows: \n* DES\n* 3DES\n* AES128\n* AES192\n* AES256", + "summary": "Returns the encryption options.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionOptions/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getEncryptionOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/getKeylifeLimits": { + "get": { + "description": "The keylife limits. Keylife max limit is set to 120. Keylife min limit is set to 172800.", + "summary": "Returns the keylife min and max limits.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getKeylifeLimits/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getKeylifeLimits", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Network_Tunnel_Module_Context object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Tunnel_Module_Context service. The IPSec network tunnel will be returned if it is associated with the account and the user has proper permission to manage network tunnels. ", + "summary": "Retrieve a SoftLayer_Network_Tunnel_Module_Context record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getObject/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Tunnel_Module_Context" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getParameterConfigurationsForCustomerView": { + "get": { + "description": "All of the IPSec VPN tunnel's configurations will be returned. It will list all of phase one and two negotiation parameters. Both remote and local subnets will be provided as well. This is useful when the configurations need to be passed on to another team and/or company for internal network configuration. ", + "summary": "Build and returns IPsec VPN tunnel configurations", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getParameterConfigurationsForCustomerView/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getParameterConfigurationsForCustomerView", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/getPhaseOneKeylifeDefault": { + "get": { + "description": "The default phase 1 keylife used if a value is not provided. The default value is set to 3600. ", + "summary": "Returns the phase one keylife default.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseOneKeylifeDefault/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getPhaseOneKeylifeDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/getPhaseTwoKeylifeDefault": { + "get": { + "description": "The default phase 2 keylife used if a value is not provided. The default value is set to 28800. ", + "summary": "Returns phase two keylife default.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseTwoKeylifeDefault/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getPhaseTwoKeylifeDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/removeCustomerSubnetFromNetworkTunnel": { + "post": { + "description": "Disassociate a customer subnet (remote) from a network tunnel. When a remote subnet is disassociated, that subnet will not able to communicate with private and service subnets on the SoftLayer network. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for the disassociation described above to take effect. ", + "summary": "Disassociate a customer (remote) subnet from a network tunnel", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeCustomerSubnetFromNetworkTunnel/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::removeCustomerSubnetFromNetworkTunnel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/removePrivateSubnetFromNetworkTunnel": { + "post": { + "description": "Disassociate a private subnet from a network tunnel. When a private subnet is disassociated, the customer (remote) subnet on the other end of the tunnel will not able to communicate with the private subnet that was just disassociated. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for the disassociation described above to take effect. ", + "summary": "Disassociate a private subnet from a network tunnel", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/removePrivateSubnetFromNetworkTunnel/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::removePrivateSubnetFromNetworkTunnel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/removeServiceSubnetFromNetworkTunnel": { + "post": { + "description": "Disassociate a service subnet from a network tunnel. When a service subnet is disassociated, that customer (remote) subnet on the other end of the network tunnel will not able to communicate with that service subnet on the SoftLayer network. \n\nNOTE: A network tunnel's configurations must be applied to the network device in order for the disassociation described above to take effect. ", + "summary": "Disassociate service subnet from a network tunnel", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeServiceSubnetFromNetworkTunnel/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::removeServiceSubnetFromNetworkTunnel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getAccount": { + "get": { + "description": "The account that a network tunnel belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAccount/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getActiveTransaction": { + "get": { + "description": "DEPRECATED", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getActiveTransaction/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getActiveTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getAddressTranslations": { + "get": { + "description": "A network tunnel's address translations.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslations/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getAddressTranslations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Tunnel_Module_Context_Address_Translation" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getAllAvailableServiceSubnets": { + "get": { + "description": "Subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAllAvailableServiceSubnets/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getAllAvailableServiceSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getBillingItem": { + "get": { + "description": "The current billing item for network tunnel.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getBillingItem/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getCustomerSubnets": { + "get": { + "description": "Remote subnets that are allowed access through a network tunnel.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getCustomerSubnets/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getCustomerSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Customer_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getDatacenter": { + "get": { + "description": "The datacenter location for one end of the network tunnel that allows access to account's private subnets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDatacenter/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getInternalSubnets": { + "get": { + "description": "Private subnets that can be accessed through the network tunnel.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getInternalSubnets/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getInternalSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getServiceSubnets": { + "get": { + "description": "Service subnets that can be access through the network tunnel.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getServiceSubnets/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getServiceSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getStaticRouteSubnets": { + "get": { + "description": "Subnets used for a network tunnel's address translations.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getStaticRouteSubnets/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getStaticRouteSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Tunnel_Module_Context/{SoftLayer_Network_Tunnel_Module_ContextID}/getTransactionHistory": { + "get": { + "description": "DEPRECATED", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Tunnel_Module_Context/getTransactionHistory/", + "operationId": "SoftLayer_Network_Tunnel_Module_Context::getTransactionHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/editObject": { + "post": { + "description": "Updates this VLAN using the provided VLAN template. \n\nThe following properties may be modified. \n\n- \"name\" - A description no more than 20 characters in length. ", + "summary": "Update the properties of this VLAN", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/editObject/", + "operationId": "SoftLayer_Network_Vlan::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getCancelFailureReasons": { + "get": { + "description": "Evaluates this VLAN for cancellation and returns a list of descriptions why this VLAN may not be cancelled. If the result is empty, this VLAN may be cancelled. ", + "summary": "A list of descriptions why this VLAN may not be cancelled.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getCancelFailureReasons/", + "operationId": "SoftLayer_Network_Vlan::getCancelFailureReasons", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getFirewallProtectableIpAddresses": { + "get": { + "description": "\n*** DEPRECATED ***\nRetrieves the IP addresses routed on this VLAN that are protectable by a Hardware Firewall. ", + "summary": "[DEPRECATED] Retrieve the IP addresses routed on this VLAN that are protectable by a Hardware Firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableIpAddresses/", + "operationId": "SoftLayer_Network_Vlan::getFirewallProtectableIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getFirewallProtectableSubnets": { + "get": { + "description": "\n*** DEPRECATED ***\nRetrieves the subnets routed on this VLAN that are protectable by a Hardware Firewall. ", + "summary": "[DEPRECATED] Retrieve the subnets routed on this VLAN that are protectable by a Hardware Firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableSubnets/", + "operationId": "SoftLayer_Network_Vlan::getFirewallProtectableSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getIpAddressUsage": { + "get": { + "description": "Returns a list of IP address assignment details. Only assigned IP addresses are reported on. IP address assignments are presently only recorded and available for Primary Subnets. \n\nDetails on the resource assigned to each IP address will only be provided to users with access to the underlying resource. If the user cannot access the resource, a detail record will still be returned for the assignment but without any accompanying resource data. ", + "summary": "Retrieve IP address assignment details.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getIpAddressUsage/", + "operationId": "SoftLayer_Network_Vlan::getIpAddressUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress_UsageDetail" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getObject": { + "get": { + "description": "Retrieves a VLAN by its id value. Only VLANs assigned to your account are accessible. ", + "summary": "Retrieve a SoftLayer_Network_Vlan record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getObject/", + "operationId": "SoftLayer_Network_Vlan::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getPrivateVlan": { + "get": { + "description": "\n*** DEPRECATED ***\nRetrieves a private VLAN associated to one or more hosts also associated to this public VLAN. ", + "summary": "[DEPRECATED] Retrieve a private VLAN connected to one or more hosts also connected to this public VLAN.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getPrivateVlan/", + "operationId": "SoftLayer_Network_Vlan::getPrivateVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/getPrivateVlanByIpAddress": { + "post": { + "description": "\n*** DEPRECATED ***\nRetrieve the private network VLAN associated with an IP address. ", + "summary": "[DEPRECATED] Retrieve the private network VLAN associated with an IP address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress/", + "operationId": "SoftLayer_Network_Vlan::getPrivateVlanByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/getPublicVlanByFqdn": { + "post": { + "description": "\n*** DEPRECATED ***\nRetrieves a public VLAN associated to the host matched by the given fully-qualified domain name. ", + "summary": "[DEPRECATED] Retrieve a public VLAN by an associated host's fully-qualified domain name", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getPublicVlanByFqdn/", + "operationId": "SoftLayer_Network_Vlan::getPublicVlanByFqdn", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getReverseDomainRecords": { + "get": { + "description": "\n*** DEPRECATED ***\nRetrieves DNS PTR records associated with IP addresses routed on this VLAN. Results will be grouped by DNS domain with the \"resourceRecords\" property populated. ", + "summary": "[DEPRECATED] DNS PTR records associated with IP addresses routed on this VLAN.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getReverseDomainRecords/", + "operationId": "SoftLayer_Network_Vlan::getReverseDomainRecords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Dns_Domain" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/getVlanForIpAddress": { + "post": { + "description": "Retrieves the VLAN on which the given IP address is routed.", + "summary": "The VLAN on which the given IP address is routed.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getVlanForIpAddress/", + "operationId": "SoftLayer_Network_Vlan::getVlanForIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/setTags": { + "post": { + "description": "Tag a VLAN by passing in one or more tags separated by a comma. Tag references are cleared out every time this method is called. If your VLAN is already tagged you will need to pass the current tags along with any new ones. To remove all tag references pass an empty string. To remove one or more tags omit them from the tag list. ", + "summary": "Associate tags with this VLAN.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/setTags/", + "operationId": "SoftLayer_Network_Vlan::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/updateFirewallIntraVlanCommunication": { + "post": { + "description": "\n*** DEPRECATED ***\nUpdates the firewall associated to this VLAN to allow or disallow intra-VLAN communication. ", + "summary": "[DEPRECATED] Update the firewall associated to this VLAN to allow or disallow intra-VLAN communication.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/updateFirewallIntraVlanCommunication/", + "operationId": "SoftLayer_Network_Vlan::updateFirewallIntraVlanCommunication", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/upgrade": { + "get": { + "description": "Converts this VLAN to a paid resource. This can be done for any Automatic VLAN. This operation can only be executed on an Automatic VLAN, and will transition it to being a Premium VLAN. The VLAN will then provide the benefits of a Premium VLAN. A Premium VLAN will remain on the account until cancelled. This operation cannot be undone! Once a VLAN becomes Premium, it can only be removed through cancellation, which will result in it being reclaimed. \n\nThis operation is a convenience for utilizing the SoftLayer_Product_Order.placeOrder operation. It will place an order to upgrade the VLAN it is executed against. It will take a few moments for the order to be processed and the upgrade to complete. Note that the order is placed in such a way that any account state which prevents automatic order approval will prevent the order from being placed. Thus, if no error is received, the order was placed and approved, and the VLAN will be upgraded shortly. ", + "summary": "Convert the VLAN to a paid resource, from an Automatic to a Premium VLAN.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/upgrade/", + "operationId": "SoftLayer_Network_Vlan::upgrade", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getAccount": { + "get": { + "description": "The account this VLAN is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getAccount/", + "operationId": "SoftLayer_Network_Vlan::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getAdditionalPrimarySubnets": { + "get": { + "description": "The primary IPv4 subnets routed on this VLAN, excluding the primarySubnet.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getAdditionalPrimarySubnets/", + "operationId": "SoftLayer_Network_Vlan::getAdditionalPrimarySubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getAttachedNetworkGateway": { + "get": { + "description": "The gateway device this VLAN is associated with for routing purposes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGateway/", + "operationId": "SoftLayer_Network_Vlan::getAttachedNetworkGateway", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getAttachedNetworkGatewayFlag": { + "get": { + "description": "A value of '1' indicates this VLAN is associated with a gateway device for routing purposes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayFlag/", + "operationId": "SoftLayer_Network_Vlan::getAttachedNetworkGatewayFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getAttachedNetworkGatewayVlan": { + "get": { + "description": "The gateway device VLAN context this VLAN is associated with for routing purposes.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayVlan/", + "operationId": "SoftLayer_Network_Vlan::getAttachedNetworkGatewayVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getBillingItem": { + "get": { + "description": "The billing item for this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getBillingItem/", + "operationId": "SoftLayer_Network_Vlan::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getDatacenter": { + "get": { + "description": "The datacenter this VLAN is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getDatacenter/", + "operationId": "SoftLayer_Network_Vlan::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getDedicatedFirewallFlag": { + "get": { + "description": "A value of '1' indicates this VLAN is associated with a firewall device. This does not include Hardware Firewalls.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getDedicatedFirewallFlag/", + "operationId": "SoftLayer_Network_Vlan::getDedicatedFirewallFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getExtensionRouter": { + "get": { + "description": "[DEPRECATED] The extension router that this VLAN is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getExtensionRouter/", + "operationId": "SoftLayer_Network_Vlan::getExtensionRouter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Router" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getFirewallGuestNetworkComponents": { + "get": { + "description": "The VSI network interfaces connected to this VLAN and associated with a Hardware Firewall.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getFirewallGuestNetworkComponents/", + "operationId": "SoftLayer_Network_Vlan::getFirewallGuestNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getFirewallInterfaces": { + "get": { + "description": "The context for the firewall device associated with this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getFirewallInterfaces/", + "operationId": "SoftLayer_Network_Vlan::getFirewallInterfaces", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Module_Context_Interface" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getFirewallNetworkComponents": { + "get": { + "description": "The uplinks of the hardware network interfaces connected natively to this VLAN and associated with a Hardware Firewall.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getFirewallNetworkComponents/", + "operationId": "SoftLayer_Network_Vlan::getFirewallNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getFirewallRules": { + "get": { + "description": "The access rules for the firewall device associated with this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getFirewallRules/", + "operationId": "SoftLayer_Network_Vlan::getFirewallRules", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan_Firewall_Rule" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getGuestNetworkComponents": { + "get": { + "description": "The VSI network interfaces connected to this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getGuestNetworkComponents/", + "operationId": "SoftLayer_Network_Vlan::getGuestNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getHardware": { + "get": { + "description": "The hardware with network interfaces connected natively to this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getHardware/", + "operationId": "SoftLayer_Network_Vlan::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getHighAvailabilityFirewallFlag": { + "get": { + "description": "A value of '1' indicates this VLAN is associated with a firewall device in a high availability configuration.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getHighAvailabilityFirewallFlag/", + "operationId": "SoftLayer_Network_Vlan::getHighAvailabilityFirewallFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getLocalDiskStorageCapabilityFlag": { + "get": { + "description": "A value of '1' indicates this VLAN's pod has VSI local disk storage capability.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getLocalDiskStorageCapabilityFlag/", + "operationId": "SoftLayer_Network_Vlan::getLocalDiskStorageCapabilityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getNetworkComponentTrunks": { + "get": { + "description": "The hardware network interfaces connected via trunk to this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getNetworkComponentTrunks/", + "operationId": "SoftLayer_Network_Vlan::getNetworkComponentTrunks", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Network_Vlan_Trunk" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getNetworkComponents": { + "get": { + "description": "The hardware network interfaces connected natively to this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getNetworkComponents/", + "operationId": "SoftLayer_Network_Vlan::getNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getNetworkComponentsTrunkable": { + "get": { + "description": "The viable hardware network interface trunking targets of this VLAN. Viable targets include accessible components of assigned hardware in the same pod and network as this VLAN, which are not already connected, either natively or trunked.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getNetworkComponentsTrunkable/", + "operationId": "SoftLayer_Network_Vlan::getNetworkComponentsTrunkable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getNetworkSpace": { + "get": { + "description": "The network that this VLAN is on, either PUBLIC or PRIVATE, if applicable.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getNetworkSpace/", + "operationId": "SoftLayer_Network_Vlan::getNetworkSpace", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getNetworkVlanFirewall": { + "get": { + "description": "The firewall device associated with this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getNetworkVlanFirewall/", + "operationId": "SoftLayer_Network_Vlan::getNetworkVlanFirewall", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan_Firewall" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getPodName": { + "get": { + "description": "The pod this VLAN is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getPodName/", + "operationId": "SoftLayer_Network_Vlan::getPodName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getPrimaryRouter": { + "get": { + "description": "The router device that this VLAN is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getPrimaryRouter/", + "operationId": "SoftLayer_Network_Vlan::getPrimaryRouter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Router" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getPrimarySubnet": { + "get": { + "description": "A primary IPv4 subnet routed on this VLAN, if accessible.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getPrimarySubnet/", + "operationId": "SoftLayer_Network_Vlan::getPrimarySubnet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getPrimarySubnetVersion6": { + "get": { + "description": "The primary IPv6 subnet routed on this VLAN, if IPv6 is enabled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getPrimarySubnetVersion6/", + "operationId": "SoftLayer_Network_Vlan::getPrimarySubnetVersion6", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getPrimarySubnets": { + "get": { + "description": "All primary subnets routed on this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getPrimarySubnets/", + "operationId": "SoftLayer_Network_Vlan::getPrimarySubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getPrivateNetworkGateways": { + "get": { + "description": "The gateway devices with connectivity supported by this private VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getPrivateNetworkGateways/", + "operationId": "SoftLayer_Network_Vlan::getPrivateNetworkGateways", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getProtectedIpAddresses": { + "get": { + "description": "IP addresses routed on this VLAN which are actively associated with network protections.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getProtectedIpAddresses/", + "operationId": "SoftLayer_Network_Vlan::getProtectedIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getPublicNetworkGateways": { + "get": { + "description": "The gateway devices with connectivity supported by this public VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getPublicNetworkGateways/", + "operationId": "SoftLayer_Network_Vlan::getPublicNetworkGateways", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getSanStorageCapabilityFlag": { + "get": { + "description": "A value of '1' indicates this VLAN's pod has VSI SAN disk storage capability.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getSanStorageCapabilityFlag/", + "operationId": "SoftLayer_Network_Vlan::getSanStorageCapabilityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getSecondaryRouter": { + "get": { + "description": "[DEPRECATED] The secondary router device that this VLAN is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getSecondaryRouter/", + "operationId": "SoftLayer_Network_Vlan::getSecondaryRouter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getSecondarySubnets": { + "get": { + "description": "All non-primary subnets routed on this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getSecondarySubnets/", + "operationId": "SoftLayer_Network_Vlan::getSecondarySubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getSubnets": { + "get": { + "description": "All subnets routed on this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getSubnets/", + "operationId": "SoftLayer_Network_Vlan::getSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getTagReferences": { + "get": { + "description": "The tags associated to this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getTagReferences/", + "operationId": "SoftLayer_Network_Vlan::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getTotalPrimaryIpAddressCount": { + "get": { + "description": "The number of primary IPv4 addresses routed on this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getTotalPrimaryIpAddressCount/", + "operationId": "SoftLayer_Network_Vlan::getTotalPrimaryIpAddressCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getType": { + "get": { + "description": "The type for this VLAN, with the following values: STANDARD, GATEWAY, INTERCONNECT", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getType/", + "operationId": "SoftLayer_Network_Vlan::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getVirtualGuests": { + "get": { + "description": "The VSIs with network interfaces connected to this VLAN.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan/getVirtualGuests/", + "operationId": "SoftLayer_Network_Vlan::getVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/approveBypassRequest": { + "get": { + "description": "Approve a request from technical support to bypass the firewall. Once approved, support will be able to route and unroute the VLAN on the firewall. ", + "summary": "Approve a request from technical support to bypass the firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/approveBypassRequest/", + "operationId": "SoftLayer_Network_Vlan_Firewall::approveBypassRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getFirewallFirmwareVersion": { + "get": { + "description": "Retrieve the firewall device firmware version from database. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallFirmwareVersion/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getFirewallFirmwareVersion", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getObject": { + "get": { + "description": "getObject returns a SoftLayer_Network_Vlan_Firewall object. You can only get objects for vlans attached to your account that have a network firewall enabled. ", + "summary": "Retrieve a SoftLayer_Network_Vlan_Firewall record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getObject/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan_Firewall" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/hasActiveTransactions": { + "get": { + "description": "Check for active transactions for the Firewall. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/hasActiveTransactions/", + "operationId": "SoftLayer_Network_Vlan_Firewall::hasActiveTransactions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/isAccountAllowed": { + "get": { + "description": "Checks if the account is allowed to use some features of FSA1G and Hardware firewall (Dedicated) ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/isAccountAllowed/", + "operationId": "SoftLayer_Network_Vlan_Firewall::isAccountAllowed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/isHighAvailabilityUpgradeAvailable": { + "get": { + "description": "Whether this firewall qualifies for High Availability upgrade. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/isHighAvailabilityUpgradeAvailable/", + "operationId": "SoftLayer_Network_Vlan_Firewall::isHighAvailabilityUpgradeAvailable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/rejectBypassRequest": { + "get": { + "description": "Reject a request from technical support to bypass the firewall. Once rejected, IBM support will not be able to route and unroute the VLAN on the firewall. ", + "summary": "Reject a request from technical support to bypass the firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/rejectBypassRequest/", + "operationId": "SoftLayer_Network_Vlan_Firewall::rejectBypassRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/restoreDefaults": { + "get": { + "description": "This will completely reset the firewall to factory settings. If the firewall is not a FSA 10G appliance an error will occur. Note, this process is performed asynchronously. During the process all traffic will not be routed through the firewall. ", + "summary": "Reset the FSA 10G firewall to factory settings.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/restoreDefaults/", + "operationId": "SoftLayer_Network_Vlan_Firewall::restoreDefaults", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/setTags": { + "post": { + "description": "This method will associate a comma separated list of tags with this object. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/setTags/", + "operationId": "SoftLayer_Network_Vlan_Firewall::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/updateRouteBypass": { + "post": { + "description": "Enable or disable route bypass for this context. If enabled, this will bypass the firewall entirely and all traffic will be routed directly to the host(s) behind it. If disabled, traffic will flow through the firewall normally. This feature is only available for Hardware Firewall (Dedicated) and dedicated appliances. ", + "summary": "Enable or disable route bypass.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/updateRouteBypass/", + "operationId": "SoftLayer_Network_Vlan_Firewall::updateRouteBypass", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getAccountId": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getAccountId/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getAccountId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getBandwidthAllocation": { + "get": { + "description": "A firewall's allotted bandwidth (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getBandwidthAllocation/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getBillingCycleBandwidthUsage": { + "get": { + "description": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCycleBandwidthUsage/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getBillingCycleBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getBillingCyclePrivateBandwidthUsage": { + "get": { + "description": "The raw private bandwidth usage data for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePrivateBandwidthUsage/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getBillingCyclePrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getBillingCyclePublicBandwidthUsage": { + "get": { + "description": "The raw public bandwidth usage data for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePublicBandwidthUsage/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getBillingCyclePublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getBillingItem": { + "get": { + "description": "The billing item for a Hardware Firewall (Dedicated).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingItem/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getBypassRequestStatus": { + "get": { + "description": "Administrative bypass request status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getBypassRequestStatus/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getBypassRequestStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getDatacenter": { + "get": { + "description": "The datacenter that the firewall resides in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getDatacenter/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getFirewallType": { + "get": { + "description": "The firewall device type.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallType/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getFirewallType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getFullyQualifiedDomainName": { + "get": { + "description": "A name reflecting the hostname and domain of the firewall. This is created from the combined values of the firewall's logical name and vlan number automatically, and thus can not be edited directly.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getFullyQualifiedDomainName/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getFullyQualifiedDomainName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getManagementCredentials": { + "get": { + "description": "The credentials to log in to a firewall device. This is only present for dedicated appliances.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getManagementCredentials/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getManagementCredentials", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getMetricTrackingObject": { + "get": { + "description": "A firewall's metric tracking object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObject/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getMetricTrackingObjectId": { + "get": { + "description": "The metric tracking object ID for this firewall.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObjectId/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getMetricTrackingObjectId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getNetworkFirewallUpdateRequests": { + "get": { + "description": "The update requests made for this firewall.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkFirewallUpdateRequests/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getNetworkFirewallUpdateRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Firewall_Update_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getNetworkGateway": { + "get": { + "description": "The gateway associated with this firewall, if any.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkGateway/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getNetworkGateway", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Gateway" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getNetworkVlan": { + "get": { + "description": "The VLAN object that a firewall is associated with and protecting.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlan/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getNetworkVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getNetworkVlans": { + "get": { + "description": "The VLAN objects that a firewall is associated with and protecting.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlans/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getRules": { + "get": { + "description": "The currently running rule set of this network component firewall.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getRules/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getRules", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan_Firewall_Rule" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getTagReferences/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Firewall/{SoftLayer_Network_Vlan_FirewallID}/getUpgradeRequest": { + "get": { + "description": "A firewall's associated upgrade request object, if any.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Firewall/getUpgradeRequest/", + "operationId": "SoftLayer_Network_Vlan_Firewall::getUpgradeRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Upgrade_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Network_Vlan_Type/{SoftLayer_Network_Vlan_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Network_Vlan_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Network_Vlan_Type/getObject/", + "operationId": "SoftLayer_Network_Vlan_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification/getAllObjects": { + "get": { + "description": "Use this method to retrieve all active notifications that can be subscribed to. ", + "summary": "Retrieve all Notifications that can be subscribed to.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification/getAllObjects/", + "operationId": "SoftLayer_Notification::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification/{SoftLayer_NotificationID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Notification record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification/getObject/", + "operationId": "SoftLayer_Notification::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification/{SoftLayer_NotificationID}/getPreferences": { + "get": { + "description": "The preferences related to the notification. These are preferences are configurable and optional for subscribers to use.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification/getPreferences/", + "operationId": "SoftLayer_Notification::getPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification/{SoftLayer_NotificationID}/getRequiredPreferences": { + "get": { + "description": "The required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification/getRequiredPreferences/", + "operationId": "SoftLayer_Notification::getRequiredPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Mobile/createSubscriberForMobileDevice": { + "post": { + "description": "Create a new subscriber for a given resource. ", + "summary": "Create a new subscriber for a given resource.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Mobile/createSubscriberForMobileDevice/", + "operationId": "SoftLayer_Notification_Mobile::createSubscriberForMobileDevice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Mobile/{SoftLayer_Notification_MobileID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Notification_Mobile record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Mobile/getObject/", + "operationId": "SoftLayer_Notification_Mobile::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_Mobile" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Mobile/getAllObjects": { + "get": { + "description": "Use this method to retrieve all active notifications that can be subscribed to. ", + "summary": "Retrieve all Notifications that can be subscribed to.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Mobile/getAllObjects/", + "operationId": "SoftLayer_Notification_Mobile::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Mobile/{SoftLayer_Notification_MobileID}/getPreferences": { + "get": { + "description": "The preferences related to the notification. These are preferences are configurable and optional for subscribers to use.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Mobile/getPreferences/", + "operationId": "SoftLayer_Notification_Mobile::getPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Mobile/{SoftLayer_Notification_MobileID}/getRequiredPreferences": { + "get": { + "description": "The required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Mobile/getRequiredPreferences/", + "operationId": "SoftLayer_Notification_Mobile::getRequiredPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/acknowledgeNotification": { + "get": { + "description": "<<<< EOT", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/acknowledgeNotification/", + "operationId": "SoftLayer_Notification_Occurrence_Event::acknowledgeNotification", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getAllObjects/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getAttachedFile": { + "post": { + "description": "Retrieve the contents of the file attached to a SoftLayer event by it's given identifier. ", + "summary": "Retrieve a file attached to an event.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachedFile/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getAttachedFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getImpactedAccountCount": { + "get": { + "description": "This method will return the number of impacted owned accounts associated with this event for the current user. ", + "summary": "Get the number of impacted owned accounts for the current user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccountCount/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getImpactedAccountCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getImpactedDeviceCount": { + "get": { + "description": "This method will return the number of impacted devices associated with this event for the current user. ", + "summary": "Get the number of impacted devices.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDeviceCount/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getImpactedDeviceCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getImpactedDevices": { + "get": { + "description": "This method will return a collection of SoftLayer_Notification_Occurrence_Resource objects which is a listing of the current users' impacted devices that are associated with this event. ", + "summary": "Get devices impacted by this event", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDevices/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getImpactedDevices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Resource" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Notification_Occurrence_Event record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getObject/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getAcknowledgedFlag": { + "get": { + "description": "Indicates whether or not this event has been acknowledged by the user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getAcknowledgedFlag/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getAcknowledgedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getAttachments": { + "get": { + "description": "A collection of attachments for this event which provide supplementary information to impacted users some examples are RFO (Reason For Outage) and root cause analysis documents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachments/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getAttachments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event_Attachment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getFirstUpdate": { + "get": { + "description": "The first update for this event.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getFirstUpdate/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getFirstUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Update" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getImpactedAccounts": { + "get": { + "description": "A collection of accounts impacted by this event. Each impacted account record relates directly to a [[SoftLayer_Account]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccounts/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getImpactedAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Account" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getImpactedResources": { + "get": { + "description": "A collection of resources impacted by this event. Each record will relate to some physical resource that the user has access to such as [[SoftLayer_Hardware]] or [[SoftLayer_Virtual_Guest]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedResources/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getImpactedResources", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Resource" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getImpactedUsers": { + "get": { + "description": "A collection of users impacted by this event. Each impacted user record relates directly to a [[SoftLayer_User_Customer]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedUsers/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getImpactedUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_User" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getLastUpdate": { + "get": { + "description": "The last update for this event.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getLastUpdate/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getLastUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Update" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getNotificationOccurrenceEventType": { + "get": { + "description": "The type of event such as planned or unplanned maintenance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getNotificationOccurrenceEventType/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getNotificationOccurrenceEventType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getStatusCode": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getStatusCode/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getStatusCode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Status_Code" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_Event/{SoftLayer_Notification_Occurrence_EventID}/getUpdates": { + "get": { + "description": "All updates for this event.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_Event/getUpdates/", + "operationId": "SoftLayer_Notification_Occurrence_Event::getUpdates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Update" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_User/{SoftLayer_Notification_Occurrence_UserID}/acknowledge": { + "get": { + "description": null, + "summary": "Acknowledge the associated [[SoftLayer_Notification_Occurrence_Event]] for this impacted user. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_User/acknowledge/", + "operationId": "SoftLayer_Notification_Occurrence_User::acknowledge", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_User/getAllObjects": { + "get": { + "description": null, + "summary": "Returns a collection of impacted users, an account master user has the ability to see all impacted users under the account. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_User/getAllObjects/", + "operationId": "SoftLayer_Notification_Occurrence_User::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_User" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_User/{SoftLayer_Notification_Occurrence_UserID}/getImpactedDeviceCount": { + "get": { + "description": null, + "summary": "A count representing the number of the user's devices currently impacted by the associated event will be returned. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedDeviceCount/", + "operationId": "SoftLayer_Notification_Occurrence_User::getImpactedDeviceCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_User/{SoftLayer_Notification_Occurrence_UserID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Notification_Occurrence_User record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_User/getObject/", + "operationId": "SoftLayer_Notification_Occurrence_User::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_User" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_User/{SoftLayer_Notification_Occurrence_UserID}/getImpactedResources": { + "get": { + "description": "A collection of resources impacted by the associated event.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedResources/", + "operationId": "SoftLayer_Notification_Occurrence_User::getImpactedResources", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Resource" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_User/{SoftLayer_Notification_Occurrence_UserID}/getNotificationOccurrenceEvent": { + "get": { + "description": "The associated event.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_User/getNotificationOccurrenceEvent/", + "operationId": "SoftLayer_Notification_Occurrence_User::getNotificationOccurrenceEvent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_Occurrence_User/{SoftLayer_Notification_Occurrence_UserID}/getUser": { + "get": { + "description": "The impacted user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_Occurrence_User/getUser/", + "operationId": "SoftLayer_Notification_Occurrence_User::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber/createObject": { + "post": { + "description": "Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional. \n\nThe required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on. \n\nOptional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value. \n\nFor example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure: \n\n\n*userRecordId = 1111\n*notificationId = 3\n*resourceRecord\n**resourceTableId = 1234\n*preferences[1]\n**notificationPreferenceId = 2\n**value = 85\n*preference[2]\n**notificationPreferenceId = 3\n**value = 15\n\n", + "summary": "Create a new notification subscriber.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber/createObject/", + "operationId": "SoftLayer_Notification_User_Subscriber::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber/{SoftLayer_Notification_User_SubscriberID}/editObject": { + "post": { + "description": "The subscriber's subscription status can be \"turned off\" or \"turned on\" if the subscription is not required. \n\nSubscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20 \n\n\n*id = 1111\n*active = 1\n*preferences[1]\n**id = 11\n**value = 90\n*preference[2]\n**id = 12\n**value = 20", + "summary": "Edit a notification subscriber active status", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber/editObject/", + "operationId": "SoftLayer_Notification_User_Subscriber::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber/{SoftLayer_Notification_User_SubscriberID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Notification_User_Subscriber record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber/getObject/", + "operationId": "SoftLayer_Notification_User_Subscriber::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber/{SoftLayer_Notification_User_SubscriberID}/getDeliveryMethods": { + "get": { + "description": "The delivery methods used to send the subscribed notification.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber/getDeliveryMethods/", + "operationId": "SoftLayer_Notification_User_Subscriber::getDeliveryMethods", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Delivery_Method" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber/{SoftLayer_Notification_User_SubscriberID}/getNotification": { + "get": { + "description": "Notification subscribed to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber/getNotification/", + "operationId": "SoftLayer_Notification_User_Subscriber::getNotification", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber/{SoftLayer_Notification_User_SubscriberID}/getPreferences": { + "get": { + "description": "Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber/getPreferences/", + "operationId": "SoftLayer_Notification_User_Subscriber::getPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber/{SoftLayer_Notification_User_SubscriberID}/getPreferencesDetails": { + "get": { + "description": "Preference details such as description, minimum and maximum limits, default value and unit of measure.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber/getPreferencesDetails/", + "operationId": "SoftLayer_Notification_User_Subscriber::getPreferencesDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber/{SoftLayer_Notification_User_SubscriberID}/getResourceRecord": { + "get": { + "description": "The subscriber id to resource id mapping.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber/getResourceRecord/", + "operationId": "SoftLayer_Notification_User_Subscriber::getResourceRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber_Resource" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber/{SoftLayer_Notification_User_SubscriberID}/getUserRecord": { + "get": { + "description": "User record for the subscription.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber/getUserRecord/", + "operationId": "SoftLayer_Notification_User_Subscriber::getUserRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Billing/{SoftLayer_Notification_User_Subscriber_BillingID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Notification_User_Subscriber_Billing record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getObject/", + "operationId": "SoftLayer_Notification_User_Subscriber_Billing::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber_Billing" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Billing/createObject": { + "post": { + "description": "Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional. \n\nThe required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on. \n\nOptional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value. \n\nFor example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure: \n\n\n*userRecordId = 1111\n*notificationId = 3\n*resourceRecord\n**resourceTableId = 1234\n*preferences[1]\n**notificationPreferenceId = 2\n**value = 85\n*preference[2]\n**notificationPreferenceId = 3\n**value = 15\n\n", + "summary": "Create a new notification subscriber.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Billing/createObject/", + "operationId": "SoftLayer_Notification_User_Subscriber_Billing::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Billing/{SoftLayer_Notification_User_Subscriber_BillingID}/editObject": { + "post": { + "description": "The subscriber's subscription status can be \"turned off\" or \"turned on\" if the subscription is not required. \n\nSubscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20 \n\n\n*id = 1111\n*active = 1\n*preferences[1]\n**id = 11\n**value = 90\n*preference[2]\n**id = 12\n**value = 20", + "summary": "Edit a notification subscriber active status", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Billing/editObject/", + "operationId": "SoftLayer_Notification_User_Subscriber_Billing::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Billing/{SoftLayer_Notification_User_Subscriber_BillingID}/getDeliveryMethods": { + "get": { + "description": "The delivery methods used to send the subscribed notification.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getDeliveryMethods/", + "operationId": "SoftLayer_Notification_User_Subscriber_Billing::getDeliveryMethods", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Delivery_Method" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Billing/{SoftLayer_Notification_User_Subscriber_BillingID}/getNotification": { + "get": { + "description": "Notification subscribed to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getNotification/", + "operationId": "SoftLayer_Notification_User_Subscriber_Billing::getNotification", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Billing/{SoftLayer_Notification_User_Subscriber_BillingID}/getPreferences": { + "get": { + "description": "Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferences/", + "operationId": "SoftLayer_Notification_User_Subscriber_Billing::getPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Billing/{SoftLayer_Notification_User_Subscriber_BillingID}/getPreferencesDetails": { + "get": { + "description": "Preference details such as description, minimum and maximum limits, default value and unit of measure.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferencesDetails/", + "operationId": "SoftLayer_Notification_User_Subscriber_Billing::getPreferencesDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Billing/{SoftLayer_Notification_User_Subscriber_BillingID}/getResourceRecord": { + "get": { + "description": "The subscriber id to resource id mapping.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getResourceRecord/", + "operationId": "SoftLayer_Notification_User_Subscriber_Billing::getResourceRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber_Resource" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Billing/{SoftLayer_Notification_User_Subscriber_BillingID}/getUserRecord": { + "get": { + "description": "User record for the subscription.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getUserRecord/", + "operationId": "SoftLayer_Notification_User_Subscriber_Billing::getUserRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/{SoftLayer_Notification_User_Subscriber_MobileID}/clearSnoozeTimer": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/clearSnoozeTimer/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::clearSnoozeTimer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/{SoftLayer_Notification_User_Subscriber_MobileID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Notification_User_Subscriber_Mobile record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getObject/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber_Mobile" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/{SoftLayer_Notification_User_Subscriber_MobileID}/setSnoozeTimer": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/setSnoozeTimer/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::setSnoozeTimer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/createObject": { + "post": { + "description": "Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional. \n\nThe required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on. \n\nOptional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value. \n\nFor example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure: \n\n\n*userRecordId = 1111\n*notificationId = 3\n*resourceRecord\n**resourceTableId = 1234\n*preferences[1]\n**notificationPreferenceId = 2\n**value = 85\n*preference[2]\n**notificationPreferenceId = 3\n**value = 15\n\n", + "summary": "Create a new notification subscriber.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/createObject/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/{SoftLayer_Notification_User_Subscriber_MobileID}/editObject": { + "post": { + "description": "The subscriber's subscription status can be \"turned off\" or \"turned on\" if the subscription is not required. \n\nSubscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20 \n\n\n*id = 1111\n*active = 1\n*preferences[1]\n**id = 11\n**value = 90\n*preference[2]\n**id = 12\n**value = 20", + "summary": "Edit a notification subscriber active status", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/editObject/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/{SoftLayer_Notification_User_Subscriber_MobileID}/getDeliveryMethods": { + "get": { + "description": "The delivery methods used to send the subscribed notification.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getDeliveryMethods/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::getDeliveryMethods", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Delivery_Method" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/{SoftLayer_Notification_User_Subscriber_MobileID}/getNotification": { + "get": { + "description": "Notification subscribed to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getNotification/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::getNotification", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/{SoftLayer_Notification_User_Subscriber_MobileID}/getPreferences": { + "get": { + "description": "Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferences/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::getPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/{SoftLayer_Notification_User_Subscriber_MobileID}/getPreferencesDetails": { + "get": { + "description": "Preference details such as description, minimum and maximum limits, default value and unit of measure.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferencesDetails/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::getPreferencesDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/{SoftLayer_Notification_User_Subscriber_MobileID}/getResourceRecord": { + "get": { + "description": "The subscriber id to resource id mapping.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getResourceRecord/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::getResourceRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber_Resource" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Mobile/{SoftLayer_Notification_User_Subscriber_MobileID}/getUserRecord": { + "get": { + "description": "User record for the subscription.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getUserRecord/", + "operationId": "SoftLayer_Notification_User_Subscriber_Mobile::getUserRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Preference/createObject": { + "post": { + "description": "Use the method to create a new notification preference for a subscriber ", + "summary": "Create a new notification preference for a subscriber.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Preference/createObject/", + "operationId": "SoftLayer_Notification_User_Subscriber_Preference::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Preference/editObjects": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Preference/editObjects/", + "operationId": "SoftLayer_Notification_User_Subscriber_Preference::editObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Preference/{SoftLayer_Notification_User_Subscriber_PreferenceID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Notification_User_Subscriber_Preference record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getObject/", + "operationId": "SoftLayer_Notification_User_Subscriber_Preference::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber_Preference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Preference/{SoftLayer_Notification_User_Subscriber_PreferenceID}/getDefaultPreference": { + "get": { + "description": "Details such name, keyname, minimum and maximum values for the preference.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getDefaultPreference/", + "operationId": "SoftLayer_Notification_User_Subscriber_Preference::getDefaultPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_Preference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Notification_User_Subscriber_Preference/{SoftLayer_Notification_User_Subscriber_PreferenceID}/getNotificationUserSubscriber": { + "get": { + "description": "Details of the subscriber tied to the preference.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getNotificationUserSubscriber/", + "operationId": "SoftLayer_Notification_User_Subscriber_Preference::getNotificationUserSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getObject": { + "get": { + "description": "Product Items are the products SoftLayer sells. Items have many properties that help describe what each is for. Each product items holds within it a description, tax rate information, status, and upgrade downgrade path information. ", + "summary": "Retrieve a SoftLayer_Product_Item record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getObject/", + "operationId": "SoftLayer_Product_Item::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getActivePresaleEvents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getActivePresaleEvents/", + "operationId": "SoftLayer_Product_Item::getActivePresaleEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Sales_Presale_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getActiveUsagePrices": { + "get": { + "description": "Active usage based prices.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getActiveUsagePrices/", + "operationId": "SoftLayer_Product_Item::getActiveUsagePrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getAttributes": { + "get": { + "description": "The attribute values for a product item. These are additional properties that give extra information about the product being sold.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getAttributes/", + "operationId": "SoftLayer_Product_Item::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getAvailabilityAttributes": { + "get": { + "description": "Attributes that govern when an item may no longer be available.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getAvailabilityAttributes/", + "operationId": "SoftLayer_Product_Item::getAvailabilityAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getBillingType": { + "get": { + "description": "An item's special billing type, if applicable.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getBillingType/", + "operationId": "SoftLayer_Product_Item::getBillingType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getBundle": { + "get": { + "description": "An item's included product item references. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item_Bundles objects. See the SoftLayer_Product_Item::bundleItems property for bundle of SoftLayer_Product_Item of objects.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getBundle/", + "operationId": "SoftLayer_Product_Item::getBundle", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Bundles" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getBundleItems": { + "get": { + "description": "An item's included products. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item objects.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getBundleItems/", + "operationId": "SoftLayer_Product_Item::getBundleItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getCapacityMaximum": { + "get": { + "description": "When the product capacity is best described as a range, this holds the ceiling of the range.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getCapacityMaximum/", + "operationId": "SoftLayer_Product_Item::getCapacityMaximum", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getCapacityMinimum": { + "get": { + "description": "When the product capacity is best described as a range, this holds the floor of the range.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getCapacityMinimum/", + "operationId": "SoftLayer_Product_Item::getCapacityMinimum", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getCapacityRestrictedProductFlag": { + "get": { + "description": "This flag indicates that this product is restricted by a capacity on a related product.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getCapacityRestrictedProductFlag/", + "operationId": "SoftLayer_Product_Item::getCapacityRestrictedProductFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getCategories": { + "get": { + "description": "An item's associated item categories.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getCategories/", + "operationId": "SoftLayer_Product_Item::getCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getConfigurationTemplates": { + "get": { + "description": "Some product items have configuration templates which can be used to during provisioning of that product.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getConfigurationTemplates/", + "operationId": "SoftLayer_Product_Item::getConfigurationTemplates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Template" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getConflicts": { + "get": { + "description": "An item's conflicts. For example, McAfee LinuxShield cannot be ordered with Windows. It was not meant for that operating system and as such is a conflict.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getConflicts/", + "operationId": "SoftLayer_Product_Item::getConflicts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Resource_Conflict" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getCoreRestrictedItemFlag": { + "get": { + "description": "This flag indicates that this product is restricted by the number of cores on the compute instance. This is deprecated. Use [[SoftLayer_Product_Item/getCapacityRestrictedProductFlag|getCapacityRestrictedProductFlag]]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getCoreRestrictedItemFlag/", + "operationId": "SoftLayer_Product_Item::getCoreRestrictedItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getDowngradeItem": { + "get": { + "description": "Some product items have a downgrade path. This is the first product item in the downgrade path.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getDowngradeItem/", + "operationId": "SoftLayer_Product_Item::getDowngradeItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getDowngradeItems": { + "get": { + "description": "Some product items have a downgrade path. These are those product items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getDowngradeItems/", + "operationId": "SoftLayer_Product_Item::getDowngradeItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getGlobalCategoryConflicts": { + "get": { + "description": "An item's category conflicts. For example, 10 Gbps redundant network functionality cannot be ordered with a secondary GPU and as such is a conflict.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getGlobalCategoryConflicts/", + "operationId": "SoftLayer_Product_Item::getGlobalCategoryConflicts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Resource_Conflict" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getHardwareGenericComponentModel": { + "get": { + "description": "The generic hardware component that this item represents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getHardwareGenericComponentModel/", + "operationId": "SoftLayer_Product_Item::getHardwareGenericComponentModel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Component_Model_Generic" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getHideFromPortalFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getHideFromPortalFlag/", + "operationId": "SoftLayer_Product_Item::getHideFromPortalFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getIneligibleForAccountDiscountFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getIneligibleForAccountDiscountFlag/", + "operationId": "SoftLayer_Product_Item::getIneligibleForAccountDiscountFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getInventory": { + "get": { + "description": "DEPRECATED. An item's inventory status per datacenter.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getInventory/", + "operationId": "SoftLayer_Product_Item::getInventory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Inventory" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getIsEngineeredServerProduct": { + "get": { + "description": "Flag to indicate the server product is engineered for a multi-server solution. (Deprecated)", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getIsEngineeredServerProduct/", + "operationId": "SoftLayer_Product_Item::getIsEngineeredServerProduct", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getItemCategory": { + "get": { + "description": "An item's primary item category.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getItemCategory/", + "operationId": "SoftLayer_Product_Item::getItemCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getLocalDiskFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getLocalDiskFlag/", + "operationId": "SoftLayer_Product_Item::getLocalDiskFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getLocationConflicts": { + "get": { + "description": "An item's location conflicts. For example, Dual Path network functionality cannot be ordered in WDC and as such is a conflict.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getLocationConflicts/", + "operationId": "SoftLayer_Product_Item::getLocationConflicts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Resource_Conflict" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getM2ControllerFlag": { + "get": { + "description": "Indicates whether an item is a M.2 disk controller.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getM2ControllerFlag/", + "operationId": "SoftLayer_Product_Item::getM2ControllerFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getM2DriveFlag": { + "get": { + "description": "Indicates whether an item is a M.2 drive.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getM2DriveFlag/", + "operationId": "SoftLayer_Product_Item::getM2DriveFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getMinimumNvmeBays": { + "get": { + "description": "The minimum number of bays that support NVMe SSDs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getMinimumNvmeBays/", + "operationId": "SoftLayer_Product_Item::getMinimumNvmeBays", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getNvmeDiskFlag": { + "get": { + "description": "Indicates whether an item is a NVMe SSD.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getNvmeDiskFlag/", + "operationId": "SoftLayer_Product_Item::getNvmeDiskFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getObjectStorageClusterGeolocationType": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getObjectStorageClusterGeolocationType/", + "operationId": "SoftLayer_Product_Item::getObjectStorageClusterGeolocationType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getObjectStorageItemFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getObjectStorageItemFlag/", + "operationId": "SoftLayer_Product_Item::getObjectStorageItemFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getObjectStorageServiceClass": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getObjectStorageServiceClass/", + "operationId": "SoftLayer_Product_Item::getObjectStorageServiceClass", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getPackages": { + "get": { + "description": "A collection of all the SoftLayer_Product_Package(s) in which this item exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getPackages/", + "operationId": "SoftLayer_Product_Item::getPackages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getPcieDriveFlag": { + "get": { + "description": "Indicates whether an item is a PCIe drive.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getPcieDriveFlag/", + "operationId": "SoftLayer_Product_Item::getPcieDriveFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getPhysicalCoreCapacity": { + "get": { + "description": "The number of cores that a processor has.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getPhysicalCoreCapacity/", + "operationId": "SoftLayer_Product_Item::getPhysicalCoreCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getPresaleEvents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getPresaleEvents/", + "operationId": "SoftLayer_Product_Item::getPresaleEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Sales_Presale_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getPrices": { + "get": { + "description": "A product item's prices.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getPrices/", + "operationId": "SoftLayer_Product_Item::getPrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getPrivateInterfaceCount": { + "get": { + "description": "The number of private network interfaces provided by a port_speed product.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getPrivateInterfaceCount/", + "operationId": "SoftLayer_Product_Item::getPrivateInterfaceCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getPublicInterfaceCount": { + "get": { + "description": "The number of public network interfaces provided by a port_speed product.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getPublicInterfaceCount/", + "operationId": "SoftLayer_Product_Item::getPublicInterfaceCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getRequirements": { + "get": { + "description": "If an item must be ordered with another item, it will have a requirement item here.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getRequirements/", + "operationId": "SoftLayer_Product_Item::getRequirements", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Requirement" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getRules": { + "get": { + "description": "An item's rules. This includes the requirements and conflicts to resources that an item has.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getRules/", + "operationId": "SoftLayer_Product_Item::getRules", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Rule" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getSoftwareDescription": { + "get": { + "description": "The SoftLayer_Software_Description tied to this item. This will only be populated for software items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getSoftwareDescription/", + "operationId": "SoftLayer_Product_Item::getSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getSpeedSelectServerCoreCount": { + "get": { + "description": "The total number of cores for a speed select server product.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getSpeedSelectServerCoreCount/", + "operationId": "SoftLayer_Product_Item::getSpeedSelectServerCoreCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getSpeedSelectServerFlag": { + "get": { + "description": "Indicates a speed select server item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getSpeedSelectServerFlag/", + "operationId": "SoftLayer_Product_Item::getSpeedSelectServerFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getTaxCategory": { + "get": { + "description": "An item's tax category, if applicable.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getTaxCategory/", + "operationId": "SoftLayer_Product_Item::getTaxCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Tax_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getThirdPartyPolicyAssignments": { + "get": { + "description": "Third-party policy assignments for this product.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getThirdPartyPolicyAssignments/", + "operationId": "SoftLayer_Product_Item::getThirdPartyPolicyAssignments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Policy_Assignment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getThirdPartySupportVendor": { + "get": { + "description": "The 3rd party vendor for a support subscription item. (Deprecated)", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getThirdPartySupportVendor/", + "operationId": "SoftLayer_Product_Item::getThirdPartySupportVendor", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getTotalPhysicalCoreCapacity": { + "get": { + "description": "The total number of physical processing cores (excluding virtual cores / hyperthreads) for this server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getTotalPhysicalCoreCapacity/", + "operationId": "SoftLayer_Product_Item::getTotalPhysicalCoreCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getTotalPhysicalCoreCount": { + "get": { + "description": "Shows the total number of cores. This is deprecated. Use [[SoftLayer_Product_Item/getCapacity|getCapacity]] for guest_core products and [[SoftLayer_Product_Item/getTotalPhysicalCoreCapacity|getTotalPhysicalCoreCapacity]] for server products", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getTotalPhysicalCoreCount/", + "operationId": "SoftLayer_Product_Item::getTotalPhysicalCoreCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getTotalProcessorCapacity": { + "get": { + "description": "The total number of processors for this server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getTotalProcessorCapacity/", + "operationId": "SoftLayer_Product_Item::getTotalProcessorCapacity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getUpgradeItem": { + "get": { + "description": "Some product items have an upgrade path. This is the next product item in the upgrade path.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getUpgradeItem/", + "operationId": "SoftLayer_Product_Item::getUpgradeItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item/{SoftLayer_Product_ItemID}/getUpgradeItems": { + "get": { + "description": "Some product items have an upgrade path. These are those upgrade product items.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item/getUpgradeItems/", + "operationId": "SoftLayer_Product_Item::getUpgradeItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/{SoftLayer_Product_Item_CategoryID}/getAdditionalProductsForCategory": { + "get": { + "description": "Returns a list of of active Items in the \"Additional Services\" package with their active prices for a given product item category and sorts them by price.", + "summary": "Return a list of Items in the \"Additional Services\" package with their active prices for a given product item category.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getAdditionalProductsForCategory/", + "operationId": "SoftLayer_Product_Item_Category::getAdditionalProductsForCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/getBandwidthCategories": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getBandwidthCategories/", + "operationId": "SoftLayer_Product_Item_Category::getBandwidthCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/getComputingCategories": { + "post": { + "description": "This method returns a collection of computing categories. These categories are also top level items in a service offering. ", + "summary": "Returns a collection of computing categories.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getComputingCategories/", + "operationId": "SoftLayer_Product_Item_Category::getComputingCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/getCustomUsageRatesCategories": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getCustomUsageRatesCategories/", + "operationId": "SoftLayer_Product_Item_Category::getCustomUsageRatesCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/getExternalResourceCategories": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getExternalResourceCategories/", + "operationId": "SoftLayer_Product_Item_Category::getExternalResourceCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/{SoftLayer_Product_Item_CategoryID}/getObject": { + "get": { + "description": "Each product item price must be tied to a category for it to be sold. These categories describe how a particular product item is sold. For example, the 250GB hard drive can be sold as disk0, disk1, ... disk11. There are different prices for this product item depending on which category it is. This keeps down the number of products in total. ", + "summary": "Retrieve a SoftLayer_Product_Item_Category record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getObject/", + "operationId": "SoftLayer_Product_Item_Category::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/getObjectStorageCategories": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getObjectStorageCategories/", + "operationId": "SoftLayer_Product_Item_Category::getObjectStorageCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/getSoftwareCategories": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getSoftwareCategories/", + "operationId": "SoftLayer_Product_Item_Category::getSoftwareCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/getSubnetCategories": { + "get": { + "description": "This method returns a list of subnet categories.", + "summary": "Returns a list of subnet categories.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getSubnetCategories/", + "operationId": "SoftLayer_Product_Item_Category::getSubnetCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/getTopLevelCategories": { + "post": { + "description": "This method returns a collection of computing categories. These categories are also top level items in a service offering. ", + "summary": "Returns a collection of top-level categories.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getTopLevelCategories/", + "operationId": "SoftLayer_Product_Item_Category::getTopLevelCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/getValidCancelableServiceItemCategories": { + "get": { + "description": "This method returns service product categories that can be canceled via API. You can use these categories to find the billing items you wish to cancel. ", + "summary": "Returns service product categories that can be canceled via API", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getValidCancelableServiceItemCategories/", + "operationId": "SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/getVlanCategories": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getVlanCategories/", + "operationId": "SoftLayer_Product_Item_Category::getVlanCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/{SoftLayer_Product_Item_CategoryID}/getBillingItems": { + "get": { + "description": "The billing items associated with an account that share a category code with an item category's category code.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getBillingItems/", + "operationId": "SoftLayer_Product_Item_Category::getBillingItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/{SoftLayer_Product_Item_CategoryID}/getGroup": { + "get": { + "description": "This invoice item's \"item category group\". ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getGroup/", + "operationId": "SoftLayer_Product_Item_Category::getGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/{SoftLayer_Product_Item_CategoryID}/getGroups": { + "get": { + "description": "A collection of service offering category groups. Each group contains a collection of items associated with this category.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getGroups/", + "operationId": "SoftLayer_Product_Item_Category::getGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Item_Category_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/{SoftLayer_Product_Item_CategoryID}/getOrderOptions": { + "get": { + "description": "Any unique options associated with an item category.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getOrderOptions/", + "operationId": "SoftLayer_Product_Item_Category::getOrderOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category_Order_Option_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/{SoftLayer_Product_Item_CategoryID}/getPackageConfigurations": { + "get": { + "description": "A list of configuration available in this category.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getPackageConfigurations/", + "operationId": "SoftLayer_Product_Item_Category::getPackageConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Order_Configuration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/{SoftLayer_Product_Item_CategoryID}/getPresetConfigurations": { + "get": { + "description": "A list of preset configurations this category is used in.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getPresetConfigurations/", + "operationId": "SoftLayer_Product_Item_Category::getPresetConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset_Configuration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/{SoftLayer_Product_Item_CategoryID}/getQuestionReferences": { + "get": { + "description": "The question references that are associated with an item category.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getQuestionReferences/", + "operationId": "SoftLayer_Product_Item_Category::getQuestionReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category_Question_Xref" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category/{SoftLayer_Product_Item_CategoryID}/getQuestions": { + "get": { + "description": "The questions that are associated with an item category.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category/getQuestions/", + "operationId": "SoftLayer_Product_Item_Category::getQuestions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category_Question" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Category_Group/{SoftLayer_Product_Item_Category_GroupID}/getObject": { + "get": { + "description": "Each product item category must be tied to a category group. These category groups describe how a particular product item category is categorized. For example, the disk0, disk1, ... disk11 can be categorized as Server and Attached Services. There are different groups for each of this product item category depending on the function of the item product in the subject category. ", + "summary": "Retrieve a SoftLayer_Product_Item_Category_Group record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Category_Group/getObject/", + "operationId": "SoftLayer_Product_Item_Category_Group::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Policy_Assignment/{SoftLayer_Product_Item_Policy_AssignmentID}/acceptFromTicket": { + "post": { + "description": "Register the acceptance of the associated policy to product assignment, and link the created record to a Ticket. ", + "summary": "Register acceptance of this assignment linking this record to a Ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Policy_Assignment/acceptFromTicket/", + "operationId": "SoftLayer_Product_Item_Policy_Assignment::acceptFromTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Policy_Assignment/{SoftLayer_Product_Item_Policy_AssignmentID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Product_Item_Policy_Assignment record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Policy_Assignment/getObject/", + "operationId": "SoftLayer_Product_Item_Policy_Assignment::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Policy_Assignment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Policy_Assignment/{SoftLayer_Product_Item_Policy_AssignmentID}/getPolicyDocumentContents": { + "get": { + "description": "Retrieve the binary contents of the associated PDF policy document. ", + "summary": "Retrieve the binary content of the policy document.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyDocumentContents/", + "operationId": "SoftLayer_Product_Item_Policy_Assignment::getPolicyDocumentContents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Policy_Assignment/{SoftLayer_Product_Item_Policy_AssignmentID}/getPolicyName": { + "get": { + "description": "The name of the assigned policy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyName/", + "operationId": "SoftLayer_Product_Item_Policy_Assignment::getPolicyName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Policy_Assignment/{SoftLayer_Product_Item_Policy_AssignmentID}/getProduct": { + "get": { + "description": "The [[SoftLayer_Product_Item]] for this policy assignment.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Policy_Assignment/getProduct/", + "operationId": "SoftLayer_Product_Item_Policy_Assignment::getProduct", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Product_Item_Price record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getObject/", + "operationId": "SoftLayer_Product_Item_Price::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/getUsageRatePrices": { + "post": { + "description": "Returns a collection of rate-based [[SoftLayer_Product_Item_Price]] objects associated with the [[SoftLayer_Product_Item]] objects and the [[SoftLayer_Location]] specified. The location is required to get the appropriate rate-based prices because the usage rates may vary from datacenter to datacenter. ", + "summary": "Get all the rate-based prices for the location and items specified. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getUsageRatePrices/", + "operationId": "SoftLayer_Product_Item_Price::getUsageRatePrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getAccountRestrictions": { + "get": { + "description": "The account that the item price is restricted to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getAccountRestrictions/", + "operationId": "SoftLayer_Product_Item_Price::getAccountRestrictions", + "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_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getAttributes": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getAttributes/", + "operationId": "SoftLayer_Product_Item_Price::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getBareMetalReservedCapacityFlag": { + "get": { + "description": "Signifies pricing that is only available on a bare metal reserved capacity order.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getBareMetalReservedCapacityFlag/", + "operationId": "SoftLayer_Product_Item_Price::getBareMetalReservedCapacityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getBigDataOsJournalDiskFlag": { + "get": { + "description": "Whether the price is for Big Data OS/Journal disks only. (Deprecated)", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getBigDataOsJournalDiskFlag/", + "operationId": "SoftLayer_Product_Item_Price::getBigDataOsJournalDiskFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getBundleReferences": { + "get": { + "description": "cross reference for bundles", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getBundleReferences/", + "operationId": "SoftLayer_Product_Item_Price::getBundleReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Bundles" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getCapacityRestrictionMaximum": { + "get": { + "description": "The maximum capacity value for which this price is suitable.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum/", + "operationId": "SoftLayer_Product_Item_Price::getCapacityRestrictionMaximum", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getCapacityRestrictionMinimum": { + "get": { + "description": "The minimum capacity value for which this price is suitable.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum/", + "operationId": "SoftLayer_Product_Item_Price::getCapacityRestrictionMinimum", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getCapacityRestrictionType": { + "get": { + "description": "The type of capacity restriction by which this price must abide.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionType/", + "operationId": "SoftLayer_Product_Item_Price::getCapacityRestrictionType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getCategories": { + "get": { + "description": "All categories which this item is a member.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getCategories/", + "operationId": "SoftLayer_Product_Item_Price::getCategories", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getDedicatedHostInstanceFlag": { + "get": { + "description": "Signifies pricing that is only available on a dedicated host virtual server order.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getDedicatedHostInstanceFlag/", + "operationId": "SoftLayer_Product_Item_Price::getDedicatedHostInstanceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getDefinedSoftwareLicenseFlag": { + "get": { + "description": "Whether this price defines a software license for its product item.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getDefinedSoftwareLicenseFlag/", + "operationId": "SoftLayer_Product_Item_Price::getDefinedSoftwareLicenseFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getEligibilityStrategy": { + "get": { + "description": "Eligibility strategy to assess if a customer can order using this price.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getEligibilityStrategy/", + "operationId": "SoftLayer_Product_Item_Price::getEligibilityStrategy", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getItem": { + "get": { + "description": "The product item a price is tied to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getItem/", + "operationId": "SoftLayer_Product_Item_Price::getItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getOrderPremiums": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getOrderPremiums/", + "operationId": "SoftLayer_Product_Item_Price::getOrderPremiums", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price_Premium" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getPackageReferences": { + "get": { + "description": "cross reference for packages", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getPackageReferences/", + "operationId": "SoftLayer_Product_Item_Price::getPackageReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Item_Prices" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getPackages": { + "get": { + "description": "A price's packages under which this item is sold.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getPackages/", + "operationId": "SoftLayer_Product_Item_Price::getPackages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getPresetConfigurations": { + "get": { + "description": "A list of preset configurations this price is used in.'", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getPresetConfigurations/", + "operationId": "SoftLayer_Product_Item_Price::getPresetConfigurations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Package_Preset_Configuration" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getPriceType": { + "get": { + "description": "The type keyname of this price which can be STANDARD, TIERED, or TERM.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getPriceType/", + "operationId": "SoftLayer_Product_Item_Price::getPriceType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getPricingLocationGroup": { + "get": { + "description": "The pricing location group that this price is applicable for. Prices that have a pricing location group will only be available for ordering with the locations specified on the location group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getPricingLocationGroup/", + "operationId": "SoftLayer_Product_Item_Price::getPricingLocationGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group_Pricing" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getRequiredCoreCount": { + "get": { + "description": "The number of server cores required to order this item. This is deprecated. Use [[SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum|getCapacityRestrictionMinimum]] and [[SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum|getCapacityRestrictionMaximum]]", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getRequiredCoreCount/", + "operationId": "SoftLayer_Product_Item_Price::getRequiredCoreCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price/{SoftLayer_Product_Item_PriceID}/getReservedCapacityInstanceFlag": { + "get": { + "description": "Signifies pricing that is only available on a reserved capacity virtual server order.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price/getReservedCapacityInstanceFlag/", + "operationId": "SoftLayer_Product_Item_Price::getReservedCapacityInstanceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price_Premium/{SoftLayer_Product_Item_Price_PremiumID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Product_Item_Price_Premium record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price_Premium/getObject/", + "operationId": "SoftLayer_Product_Item_Price_Premium::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price_Premium" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price_Premium/{SoftLayer_Product_Item_Price_PremiumID}/getItemPrice": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price_Premium/getItemPrice/", + "operationId": "SoftLayer_Product_Item_Price_Premium::getItemPrice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price_Premium/{SoftLayer_Product_Item_Price_PremiumID}/getLocation": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price_Premium/getLocation/", + "operationId": "SoftLayer_Product_Item_Price_Premium::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Item_Price_Premium/{SoftLayer_Product_Item_Price_PremiumID}/getPackage": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Item_Price_Premium/getPackage/", + "operationId": "SoftLayer_Product_Item_Price_Premium::getPackage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Package" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/checkItemAvailability": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/checkItemAvailability/", + "operationId": "SoftLayer_Product_Order::checkItemAvailability", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/checkItemAvailabilityForImageTemplate": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/checkItemAvailabilityForImageTemplate/", + "operationId": "SoftLayer_Product_Order::checkItemAvailabilityForImageTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/checkItemConflicts": { + "post": { + "description": "Check order items for conflicts", + "summary": "Check order items for conflicts", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/checkItemConflicts/", + "operationId": "SoftLayer_Product_Order::checkItemConflicts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/getExternalPaymentAuthorizationReceipt": { + "post": { + "description": "This method simply returns a receipt for a previously finalized payment authorization from PayPal. The response matches the response returned from placeOrder when the order was originally placed with PayPal as the payment type. ", + "summary": "Returns an order receipt for a completed external (PayPal) payment authorization.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/getExternalPaymentAuthorizationReceipt/", + "operationId": "SoftLayer_Product_Order::getExternalPaymentAuthorizationReceipt", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Receipt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/getNetworks": { + "post": { + "description": "This method is deprecated and always returns nothing. ", + "summary": "(DEPRECATED) Retrieve the networks that are available during ordering.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/getNetworks/", + "operationId": "SoftLayer_Product_Order::getNetworks", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Network" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/getResellerOrder": { + "post": { + "description": "When the account is on an external reseller brand, this service will provide a SoftLayer_Product_Order with the the pricing adjusted by the external reseller. ", + "summary": "Get External Reseller pricing where applicable", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/getResellerOrder/", + "operationId": "SoftLayer_Product_Order::getResellerOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/getTaxCalculationResult": { + "post": { + "description": "Sometimes taxes cannot be calculated immediately, so we start the calculations and let them run in the background. This method will return the current progress and information related to a specific tax calculation, which allows real-time progress updates on tax calculations. ", + "summary": "Get the results of a tax calculation.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/getTaxCalculationResult/", + "operationId": "SoftLayer_Product_Order::getTaxCalculationResult", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Tax_Cache" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/getVlans": { + "post": { + "description": "Return collections of public and private VLANs that are available during ordering. If a location ID is provided, the resulting VLANs will be limited to that location. If the Virtual Server package id (46) is provided, the VLANs will be narrowed down to those locations that contain routers with the VIRTUAL_IMAGE_STORE data attribute. \n\nFor the selectedItems parameter, this is a comma-separated string of category codes and item values. For example: \n\n- `port_speed=10,guest_disk0=LOCAL_DISK` \n\n- `port_speed=100,disk0=SAN_DISK` \n\n- `port_speed=100,private_network_only=1,guest_disk0=LOCAL_DISK` \n\nThis parameter is used to narrow the available results down even further. It's not necessary when selecting a VLAN, but it will help avoid errors when attempting to place an order. The only acceptable category codes are: \n\n- `port_speed` \n\n- A disk category, such as `guest_disk0` or `disk0`, with values of either `LOCAL_DISK` or `SAN_DISK` \n\n- `private_network_only` \n\n- `dual_path_network` \n\nFor most customers, it's sufficient to only provide the first 2 parameters. ", + "summary": "Get the VLANs that are available during ordering", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/getVlans/", + "operationId": "SoftLayer_Product_Order::getVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Network_Vlans" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/placeOrder": { + "post": { + "description": "\nUse this method to place bare metal server, virtual server and additional service orders with SoftLayer. \nUpon success, your credit card or PayPal account will incur charges for the monthly order total \n(or prorated value if ordered mid billing cycle). If all products on the order are only billed hourly, \nyou will be charged on your billing anniversary date, which occurs monthly on the day you ordered your first \nservice with SoftLayer. For new customers, you are required to provide billing information when you place an order. \nFor existing customers, the credit card on file will be charged. If you're a PayPal customer, a URL will be \nreturned from the call to [[SoftLayer_Product_Order/placeOrder]] which is to be used to finish the authorization \nprocess. This authorization tells PayPal that you indeed want to place an order with SoftLayer. \nFrom PayPal's web site, you will be redirected back to SoftLayer for your order receipt. \n\n\nWhen an order is placed, your order will be in a \"pending approval\" state. When all internal checks pass, \nyour order will be automatically approved. For orders that may need extra attention, a Sales representative \nwill review the order and contact you if necessary. Once the order is approved, your server or service will \nbe provisioned and available to you shortly thereafter. Depending on the type of server or service ordered, \nprovisioning times will vary. \n\n\n## Order Containers\n\n\n\nWhen placing API orders, it's important to order your server and services on the appropriate \n[[SoftLayer_Container_Product_Order]]. Failing to provide the correct container may delay your server or service \nfrom being provisioned in a timely manner. Some common order containers are included below. \n\n\n**Note:** `SoftLayer_Container_Product_Order_` has been removed from the containers in the table below for readability.\n\n\n| Product | Order Container | Package Type |\n| ------- | --------------- | ------------ |\n| Bare metal server by CPU | [[SoftLayer_Container_Product_Order_Hardware_Server]] | BARE_METAL_CPU |\n| Bare metal server by core | [[SoftLayer_Container_Product_Order_Hardware_Server]] | BARE_METAL_CORE |\n| Virtual server | [[SoftLayer_Container_Product_Order_Virtual_Guest]] | VIRTUAL_SERVER_INSTANCE |\n| Local & dedicated load balancers | [[SoftLayer_Container_Product_Order_Network_LoadBalancer]] | ADDITIONAL_SERVICES_LOAD_BALANCER |\n| Content delivery network | [[SoftLayer_Container_Product_Order_Network_ContentDelivery_Account]] | ADDITIONAL_SERVICES_CDN |\n| Content delivery network Addon | [[SoftLayer_Container_Product_Order_Network_ContentDelivery_Account_Addon]] | ADDITIONAL_SERVICES_CDN_ADDON |\n| Hardware & software firewalls | [[SoftLayer_Container_Product_Order_Network_Protection_Firewall]] | ADDITIONAL_SERVICES_FIREWALL |\n| Dedicated firewall | [[SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated]] | ADDITIONAL_SERVICES_FIREWALL |\n| Object storage | [[SoftLayer_Container_Product_Order_Network_Storage_Object]] | ADDITIONAL_SERVICES_OBJECT_STORAGE |\n| Object storage (hub) | [[SoftLayer_Container_Product_Order_Network_Storage_Hub]] | ADDITIONAL_SERVICES_OBJECT_STORAGE |\n| Network attached storage | [[SoftLayer_Container_Product_Order_Network_Storage_Nas]] | ADDITIONAL_SERVICES_NETWORK_ATTACHED_STORAGE |\n| Iscsi storage | [[SoftLayer_Container_Product_Order_Network_Storage_Iscsi]] | ADDITIONAL_SERVICES_ISCSI_STORAGE |\n| Evault | [[SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault]] | ADDITIONAL_SERVICES |\n| Evault Plugin | [[SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin]] | ADDITIONAL_SERVICES |\n| Application delivery appliance | [[SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller]] | ADDITIONAL_SERVICES_APPLICATION_DELIVERY_APPLIANCE |\n| Network subnet | [[SoftLayer_Container_Product_Order_Network_Subnet]] | ADDITIONAL_SERVICES |\n| Global IPv4 | [[SoftLayer_Container_Product_Order_Network_Subnet]] | ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES |\n| Global IPv6 | [[SoftLayer_Container_Product_Order_Network_Subnet]] | ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES |\n| Network VLAN | [[SoftLayer_Container_Product_Order_Network_Vlan]] | ADDITIONAL_SERVICES_NETWORK_VLAN |\n| Portable storage | [[SoftLayer_Container_Product_Order_Virtual_Disk_Image]] | ADDITIONAL_SERVICES_PORTABLE_STORAGE |\n| SSL certificate | [[SoftLayer_Container_Product_Order_Security_Certificate]] | ADDITIONAL_SERVICES_SSL_CERTIFICATE |\n| External authentication | [[SoftLayer_Container_Product_Order_User_Customer_External_Binding]] | ADDITIONAL_SERVICES |\n| Dedicated Host | [[SoftLayer_Container_Product_Order_Virtual_DedicatedHost]] | DEDICATED_HOST |\n\n\n## Server example\n\n\n\nThis example includes a single bare metal server being ordered with monthly billing. \n\n\n**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the\n\navailable prices from the bare metal server [[SoftLayer_Product_Package/getAllObjects]], which have a \n[[SoftLayer_Product_Package_Type]] of `BARE_METAL_CPU` or `BARE_METAL_CORE`. You can get a full list of \npackage types with [[SoftLayer_Product_Package_Type/getAllObjects]]. \n\n\n### Bare Metal Ordering\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n \n \n example.com \n server1 \n \n \n 138124 \n 142 \n \n \n 58 \n \n \n 22337 \n \n \n 21189 \n \n \n 876 \n \n \n 57 \n \n \n 55 \n \n \n 21190 \n \n \n 36381 \n \n \n 21 \n \n \n 22013 \n \n \n 906 \n \n \n 420 \n \n \n 418 \n \n \n 342 \n \n \n false \n \n \n \n \n \n``` \n\n\n## Virtual server example\n\n\n\nThis example includes 2 identical virtual servers (except for hostname) being ordered for hourly billing. \nIt includes an optional image template id and VLAN data specified on the virtualGuest objects - \n`primaryBackendNetworkComponent` and `primaryNetworkComponent`. \n\n\n**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the\n\navailable prices from the virtual server package with [[SoftLayer_Product_Package/getAllObjects]], \nwhich has a [[SoftLayer_Product_Package_Type]] of `VIRTUAL_SERVER_INSTANCE`. \n\n\n#### Virtual Ordering\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n 13251 \n 37473 \n 46 \n \n \n 2159 \n \n \n 55 \n \n \n 13754 \n \n \n 1641 \n \n \n 905 \n \n \n 1800 \n \n \n 58 \n \n \n 21 \n \n \n 1645 \n \n \n 272 \n \n \n 57 \n \n \n 418 \n \n \n 420 \n \n \n 2 \n true \n \n \n example.com \n server1 \n \n \n 12345 \n \n \n \n \n 67890 \n \n \n \n \n example.com \n server2 \n \n \n 12345 \n \n \n \n \n 67890 \n \n \n \n \n \n \n \n \n \n``` \n\n\n## VLAN example\n\n\n**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the\n\navailable prices from the additional services pacakge with [[SoftLayer_Product_Package/getAllObjects]], \nwhich has a [[SoftLayer_Product_Package_Type]] of `ADDITIONAL_SERVICES`. \nYou can get a full list of [[SoftLayer_Product_Package_Type/getAllObjects|]] to find other available additional \nservice packages.

\n\n\n### VLAN Ordering\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n 154820 \n 0 \n \n \n 2021 \n \n \n 2018 \n \n \n true \n \n \n \n \n \n``` \n\n\n## Multiple products example\n\n\n\nThis example includes a combination of the above examples in a single order. Note that all the configuration \noptions for each individual order container are the same as above, except now we encapsulate each one within \nthe `orderContainers` property on the base [[SoftLayer_Container_Product_Order]]. \n\n\n**Warning:** not all products are available to be ordered with other products. For example, since\n\nSSL certificates require validation from a 3rd party, the approval process may take days or even weeks, \nand this would not be acceptable when you need your hourly virtual server right now. To better accommodate \ncustomers, we restrict several products to be ordered individually. \n\n\n### Bare metal server + virtual server + VLAN\n\n\n\n```xml \n \n \n \n your username \n your api key \n \n \n \n \n \n \n \n ... \n \n \n ... \n \n \n ... \n \n \n \n \n \n \n \n``` \n\n", + "summary": "Place an order using the [[SoftLayer_Container_Product_Order]] data type.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/placeOrder/", + "operationId": "SoftLayer_Product_Order::placeOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Receipt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/placeQuote": { + "post": { + "description": "Use this method for placing server quotes and additional services quotes. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server quotes. After placing the quote, you must go to this URL to finish the order process. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval. ", + "summary": "Place a quote", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/placeQuote/", + "operationId": "SoftLayer_Product_Order::placeQuote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Receipt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/processExternalPaymentAuthorization": { + "post": { + "description": "This method simply finalizes an authorization from PayPal. It tells SoftLayer that the customer has completed the PayPal process. This is ONLY needed if you, the customer, have your own API into PayPal and wish to automate authorizations from PayPal and our system. For most, this method will not be needed. Once an order is placed using placeOrder() for PayPal customers, a URL is given back to the customer. In it is the token and PayerID. If you want to systematically pay with PayPal, do so then call this method with the token and PayerID. ", + "summary": "Process an external (PayPal) payment authorization.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/processExternalPaymentAuthorization/", + "operationId": "SoftLayer_Product_Order::processExternalPaymentAuthorization", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/requiredItems": { + "post": { + "description": "Get list of items that are required with the item prices provided", + "summary": "Get list of items that are required with the item prices provided", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Product_Order/requiredItems/", + "operationId": "SoftLayer_Product_Order::requiredItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Order/verifyOrder": { + "post": { + "description": "This service is used to verify that an order meets all the necessary requirements to purchase a server, virtual server or service from SoftLayer. It will verify that the products requested do not conflict. For example, you cannot order a Windows firewall with a Linux operating system. It will also check to make sure you have provided all the products that are required for the [[SoftLayer_Product_Package_Order_Configuration]] associated with the [[SoftLayer_Product_Package]] on each of the [[SoftLayer_Container_Product_Order]] specified.

\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\nverifyOrder 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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getCdnItems": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getCloudStorageItems": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getMessageQueueItems": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Product_Package record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getAccountRestrictedActivePresets": { + "get": { + "description": "The preset configurations available only for the authenticated account and this package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActivePresets": { + "get": { + "description": "The available preset configurations for this package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActiveRamItems": { + "get": { + "description": "A collection of valid RAM items available for purchase in this package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActiveServerItems": { + "get": { + "description": "A collection of valid server items available for purchase in this package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getActiveSoftwareItems": { + "get": { + "description": "A collection of valid software items available for purchase in this package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getAdditionalServiceFlag": { + "get": { + "description": "This flag indicates that the package is an additional service.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getAttributes": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDefaultBootCategoryCode": { + "get": { + "description": "The default boot category code for the package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDefaultRamItems": { + "get": { + "description": "A collection of valid RAM items available for purchase in this package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeploymentNodeType": { + "get": { + "description": "The node type for a package in a solution deployment.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeploymentPackages": { + "get": { + "description": "The packages that are allowed in a multi-server solution. (Deprecated)", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeploymentType": { + "get": { + "description": "The solution deployment type.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeployments": { + "get": { + "description": "The package that represents a multi-server solution. (Deprecated)", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDisallowCustomDiskPartitions": { + "get": { + "description": "This flag indicates the package does not allow custom disk partitions.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getGatewayApplianceFlag": { + "get": { + "description": "Whether the package is a specialized network gateway appliance package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getGpuFlag": { + "get": { + "description": "This flag indicates that the package supports GPUs.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getHourlyBillingAvailableFlag": { + "get": { + "description": "Determines whether the package contains prices that can be ordered hourly.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getHourlyOnlyOrders": { + "get": { + "description": "Packages with this flag do not allow monthly orders.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItemConflicts": { + "get": { + "description": "The item-item conflicts associated with a package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItemLocationConflicts": { + "get": { + "description": "The item-location conflicts associated with a package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItemPriceReferences": { + "get": { + "description": "cross reference for item prices", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItemPrices": { + "get": { + "description": "A collection of SoftLayer_Product_Item_Prices that are valid for this package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getItems": { + "get": { + "description": "A collection of valid items available for purchase in this package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getLowestServerPrice": { + "get": { + "description": "The lowest server [[SoftLayer_Product_Item_Price]] related to this package.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getMaximumPortSpeed": { + "get": { + "description": "The maximum available network speed associated with the package.", + "summary": "", + "externalDocs": "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": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getMinimumPortSpeed": { + "get": { + "description": "The minimum available network speed associated with the package.", + "summary": "", + "externalDocs": "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": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getMongoDbEngineeredFlag": { + "get": { + "description": "This flag indicates that this is a MongoDB engineered package. (Deprecated)", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getNoUpgradesFlag": { + "get": { + "description": "Services ordered from this package cannot have upgrades or downgrades performed.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getNonEuCompliantFlag": { + "get": { + "description": "Whether the package is not in compliance with EU support.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPreconfiguredFlag": { + "get": { + "description": "This flag indicates the package is pre-configured. (Deprecated)", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPresetConfigurationRequiredFlag": { + "get": { + "description": "Whether the package requires the user to define a preset configuration.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPreventVlanSelectionFlag": { + "get": { + "description": "Whether the package prevents the user from specifying a Vlan.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPrivateHostedCloudPackageFlag": { + "get": { + "description": "This flag indicates the package is for a private hosted cloud deployment. (Deprecated)", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPrivateHostedCloudPackageType": { + "get": { + "description": "The server role of the private hosted cloud deployment. (Deprecated)", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getPrivateNetworkOnlyFlag": { + "get": { + "description": "Whether the package only has access to the private network.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getQuantaStorPackageFlag": { + "get": { + "description": "Whether the package is a specialized mass storage QuantaStor package. (Deprecated)", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getRaidDiskRestrictionFlag": { + "get": { + "description": "This flag indicates the package does not allow different disks with RAID.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getRedundantPowerFlag": { + "get": { + "description": "This flag determines if the package contains a redundant power supply product.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getRegions": { + "get": { + "description": "The regional locations that a package is available in.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getTopLevelItemCategoryCode": { + "get": { + "description": "The top level category code for this service offering.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Preset/getAllObjects": { + "get": { + "description": "This method returns all the active package presets.", + "summary": "Get all active package presets", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getAvailableStorageUnits": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getCategories": { + "get": { + "description": "The item categories that are included in this package preset configuration.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getComputeGroup": { + "get": { + "description": "The compute family this configuration belongs to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getConfiguration": { + "get": { + "description": "The preset configuration (category and price).", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getLowestPresetServerPrice": { + "get": { + "description": "The lowest server prices related to this package preset.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getPackage": { + "get": { + "description": "The package this preset belongs to.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getPrices": { + "get": { + "description": "The item prices that are included in this package preset configuration.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Preset/{SoftLayer_Product_Package_PresetID}/getStorageGroupTemplateArrays": { + "get": { + "description": "Describes how all disks in this preset will be configured.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Product_Package_Server/getAllObjects": { + "get": { + "description": "This method will grab all the package servers. ", + "summary": "Get the package servers", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getCatalog": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getItem": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getItemPrice": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getPackage": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Server/{SoftLayer_Product_Package_ServerID}/getPreset": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Type/getAllObjects": { + "get": { + "description": "This method will return all of the available package types. ", + "summary": "Get all the package types.", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Package_Type/{SoftLayer_Product_Package_TypeID}/getPackages": { + "get": { + "description": "All the packages associated with the given package type.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Promotion/findByPromoCode": { + "post": { + "description": "Retrieves a promotion using its code.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Promotion/{SoftLayer_Product_PromotionID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Product_Promotion record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getAccount": { + "get": { + "description": "The account that an order belongs to", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getCompletedFlag": { + "get": { + "description": "Indicates that the upgrade request has completed or has been cancelled.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getOrder": { + "get": { + "description": "An order record associated to the upgrade request", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getServer": { + "get": { + "description": "A server object associated with the upgrade request if any.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getStatus": { + "get": { + "description": "The current status of the upgrade request.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getTicket": { + "get": { + "description": "The ticket that is used to coordinate the upgrade process.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getUser": { + "get": { + "description": "The user that placed the order.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Product_Upgrade_Request/{SoftLayer_Product_Upgrade_RequestID}/getVirtualGuest": { + "get": { + "description": "A virtual server object associated with the upgrade request if any.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Hook/createObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Hook/{SoftLayer_Provisioning_HookID}/deleteObject": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Hook/{SoftLayer_Provisioning_HookID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Hook/{SoftLayer_Provisioning_HookID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Provisioning_Hook record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Hook/{SoftLayer_Provisioning_HookID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Hook/{SoftLayer_Provisioning_HookID}/getHookType": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Hook_Type/getAllHookTypes": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Classification/{SoftLayer_Provisioning_Maintenance_ClassificationID}/getItemCategories": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Classification_Item_Category/{SoftLayer_Provisioning_Maintenance_Classification_Item_CategoryID}/getMaintenanceClassification": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Slots/{SoftLayer_Provisioning_Maintenance_SlotsID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Provisioning_Maintenance_Slots record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Ticket/{SoftLayer_Provisioning_Maintenance_TicketID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Provisioning_Maintenance_Ticket record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Ticket/{SoftLayer_Provisioning_Maintenance_TicketID}/getAvailableSlots": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Ticket/{SoftLayer_Provisioning_Maintenance_TicketID}/getMaintenanceClass": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Ticket/{SoftLayer_Provisioning_Maintenance_TicketID}/getTicket": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Window/addCustomerUpgradeWindow": { + "post": { + "description": "getMaintenceWindowForTicket() returns a boolean ", + "summary": "Updates or creates records in the", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Window/getMaintenanceClassifications": { + "get": { + "description": "Returns all the maintenance classifications. ", + "summary": "Returns the maintenance classifications", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowForTicket": { + "post": { + "description": "Returns a specific maintenance window. ", + "summary": "Returns a specific maintenance window", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowTicketsByTicketId": { + "post": { + "description": "getMaintenanceWindowTicketsByTicketId() returns a list maintenance window ticket records by ticket id ", + "summary": "Returns maintenance window ticket", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindows": { + "post": { + "description": "This method returns a list of available maintenance windows ", + "summary": "Returns available maintenance windows", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Maintenance_Window/getMaintenceWindows": { + "post": { + "description": "(DEPRECATED) Use [[SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindows|getMaintenanceWindows]] method. ", + "summary": "Returns available maintenance windows", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Version1_Transaction_Group/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Version1_Transaction_OrderTracking/{SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Provisioning_Version1_Transaction_OrderTracking record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Version1_Transaction_OrderTracking/{SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID}/getInvoiceId": { + "get": { + "description": "Invoice ID", + "summary": "", + "externalDocs": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Provisioning_Version1_Transaction_OrderTracking/{SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID}/getOrderTrackingState": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Version1_Transaction_OrderTracking/{SoftLayer_Provisioning_Version1_Transaction_OrderTrackingID}/getTransaction": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState/{SoftLayer_Provisioning_Version1_Transaction_OrderTrackingStateID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState record.", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Resource_Group record.", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getAncestorGroups": { + "get": { + "description": "A resource group's associated group ancestors.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getAttributes": { + "get": { + "description": "A resource group's associated attributes.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getHardwareMembers": { + "get": { + "description": "A resource group's associated hardware members.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getMembers": { + "get": { + "description": "A resource group's associated members.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getRootResourceGroup": { + "get": { + "description": "A resource group's associated root resource group.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getSubnetMembers": { + "get": { + "description": "A resource group's associated subnet members.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getTemplate": { + "get": { + "description": "A resource group's associated template.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group/{SoftLayer_Resource_GroupID}/getVlanMembers": { + "get": { + "description": "A resource group's associated VLAN members.", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group_Template/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "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": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group_Template/{SoftLayer_Resource_Group_TemplateID}/getChildren": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Group_Template/{SoftLayer_Resource_Group_TemplateID}/getMembers": { + "get": { + "description": "", + "summary": "", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getDomain": { + "get": { + "description": "The getDomain method retrieves the hostname for the resource.", + "summary": "A resource's domain", + "externalDocs": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getGlobalIdentifier": { + "get": { + "description": "The getId getGlobalIdentifier retrieves the globalIdentifier for the resource", + "summary": "A resource's globalIdentifier", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getHostname": { + "get": { + "description": "The getHostname method retrieves the hostname for the resource.", + "summary": "A resource's hostname", + "externalDocs": "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": [] + } + ] + } + }, + "SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getId": { + "get": { + "description": "The getId method retrieves the ID for the resource", + "summary": "A resource's id", + "externalDocs": "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": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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": "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": [] + } + ] + } + }, + "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 =
for each service resource. ", + "summary": "Obtain service resources associated with the resource", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getServiceResources/", + "operationId": "SoftLayer_Resource_Metadata::getServiceResources", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Resource_Metadata_ServiceResource" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getTags": { + "get": { + "description": "The getTags method retrieves all tags associated with the resource. Tags are single keywords assigned to a resource that assist the user in identifying the resource and its roles when performing a simple search. Tags are assigned by any user with access to the resource. ", + "summary": "Obtain tags associated with the resource", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getTags/", + "operationId": "SoftLayer_Resource_Metadata::getTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getUserMetadata": { + "get": { + "description": "The getUserMetadata method retrieves metadata completed by users who interact with the resource. Metadata gathered using this method is unique to parameters set using the '''setUserMetadata''' method, which must be executed prior to completing this method. User metadata may also be provided while placing an order for a resource. ", + "summary": "Obtain user data associated with the resource", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getUserMetadata/", + "operationId": "SoftLayer_Resource_Metadata::getUserMetadata", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getVlanIds": { + "post": { + "description": "The getVlanIds method returns a list of VLAN IDs for the network component matching the provided MAC address associated with the resource. For each return, the native VLAN will appear first, followed by any trunked VLANs associated with the network component. ", + "summary": "A list of VLAN ids for a network component", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getVlanIds/", + "operationId": "SoftLayer_Resource_Metadata::getVlanIds", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getVlans": { + "post": { + "description": "The getVlans method returns a list of VLAN numbers for the network component matching the provided MAC address associated with the resource. For each return, the native VLAN will appear first, followed by any trunked VLANs associated with the network component. ", + "summary": "A list of VLAN numbers for a network component", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata/getVlans/", + "operationId": "SoftLayer_Resource_Metadata::getVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Sales_Presale_Event/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Sales_Presale_Event/getAllObjects/", + "operationId": "SoftLayer_Sales_Presale_Event::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Sales_Presale_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Sales_Presale_Event/{SoftLayer_Sales_Presale_EventID}/getObject": { + "get": { + "description": "'''getObject''' retrieves the [[SoftLayer_Sales_Presale_Event]] object whose id number corresponds to the id number of the init parameter passed to the SoftLayer_Sales_Presale_Event service. Customers may only retrieve presale events that are currently active. ", + "summary": "Retrieve a SoftLayer_Sales_Presale_Event record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Sales_Presale_Event/getObject/", + "operationId": "SoftLayer_Sales_Presale_Event::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Sales_Presale_Event" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Sales_Presale_Event/{SoftLayer_Sales_Presale_EventID}/getActiveFlag": { + "get": { + "description": "A flag to indicate that the presale event is currently active. A presale event is active if the current time is between the start and end dates.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Sales_Presale_Event/getActiveFlag/", + "operationId": "SoftLayer_Sales_Presale_Event::getActiveFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Sales_Presale_Event/{SoftLayer_Sales_Presale_EventID}/getExpiredFlag": { + "get": { + "description": "A flag to indicate that the presale event is expired. A presale event is expired if the current time is after the end date.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Sales_Presale_Event/getExpiredFlag/", + "operationId": "SoftLayer_Sales_Presale_Event::getExpiredFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Sales_Presale_Event/{SoftLayer_Sales_Presale_EventID}/getItem": { + "get": { + "description": "The [[SoftLayer_Product_Item]] associated with the presale event.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Sales_Presale_Event/getItem/", + "operationId": "SoftLayer_Sales_Presale_Event::getItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Sales_Presale_Event/{SoftLayer_Sales_Presale_EventID}/getLocation": { + "get": { + "description": "The [[SoftLayer_Location]] associated with the presale event.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Sales_Presale_Event/getLocation/", + "operationId": "SoftLayer_Sales_Presale_Event::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Sales_Presale_Event/{SoftLayer_Sales_Presale_EventID}/getOrders": { + "get": { + "description": "The orders ([[SoftLayer_Billing_Order]]) associated with this presale event that were created for the customer's account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Sales_Presale_Event/getOrders/", + "operationId": "SoftLayer_Sales_Presale_Event::getOrders", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Search/advancedSearch": { + "post": { + "description": "This method allows for searching for SoftLayer resources by simple terms and operators. Fields that are used for searching will be available at sldn.softlayer.com. It returns a collection or array of [[SoftLayer_Container_Search_Result]] objects that have search metadata for each result and the resulting resource found. \n\nThe advancedSearch() method recognizes the special _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
\n\nAn exact search (double-quote) for \"baremetal-a\" will return only the exact match of baremetal-a. \n\nA fuzzy search (no double-quote) for baremetal-a will return baremetal-a, baremetal-b, a-virtual-guest, b-virtual-guest but will omit edge-router. ", + "summary": "Search for SoftLayer Resources by simple terms.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Search/advancedSearch/", + "operationId": "SoftLayer_Search::advancedSearch", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Search_Result" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Search/getObjectTypes": { + "get": { + "description": "This method returns a collection of [[SoftLayer_Container_Search_ObjectType]] containers that specify which indexed object types and properties are exposed for the current user. These object types can be used to discover searchable data and to create or validate object index search strings. \n\n\n\nRefer to the [[SoftLayer_Search/search]] and [[SoftLayer_Search/advancedSearch]] methods for information on using object types and properties in search strings. ", + "summary": "Return a collection of indexed object types. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Search/getObjectTypes/", + "operationId": "SoftLayer_Search::getObjectTypes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Search_ObjectType" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Search/search": { + "post": { + "description": "This method allows for searching for SoftLayer resources by simple phrase. It returns a collection or array of [[SoftLayer_Container_Search_Result]] objects that have search metadata for each result and the resulting resource found. \n\nThis method recognizes the special _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
\n\nAn exact search (double-quote) for \"baremetal-a\" will return only the exact match of baremetal-a. \n\nA fuzzy search (no double-quote) for baremetal-a will return baremetal-a, baremetal-b, a-virtual-guest, b-virtual-guest but will omit edge-router. ", + "summary": "Search for SoftLayer Resources by simple phrase.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Search/search/", + "operationId": "SoftLayer_Search::search", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Search_Result" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate/createObject": { + "post": { + "description": "Add a certificate to your account for your records, or for use with various services. Only the certificate and private key are usually required. If your issuer provided an intermediate certificate, you must also provide that certificate. Details will be extracted from the certificate. Validation will be performed between the certificate and the private key as well as the certificate and the intermediate certificate, if provided. \n\nThe certificate signing request is not required, but can be provided for your records. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate/createObject/", + "operationId": "SoftLayer_Security_Certificate::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate/{SoftLayer_Security_CertificateID}/deleteObject": { + "get": { + "description": "Remove a certificate from your account. You may not remove a certificate with associated services. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate/deleteObject/", + "operationId": "SoftLayer_Security_Certificate::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate/{SoftLayer_Security_CertificateID}/editObject": { + "post": { + "description": "Update a certificate. Modifications are restricted to the note and CSR if the are any services associated with the certificate. There are no modification restrictions for a certificate with no associated services. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate/editObject/", + "operationId": "SoftLayer_Security_Certificate::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate/findByCommonName": { + "post": { + "description": "Locate certificates by their common name, traditionally a domain name. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate/findByCommonName/", + "operationId": "SoftLayer_Security_Certificate::findByCommonName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate/{SoftLayer_Security_CertificateID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Security_Certificate record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate/getObject/", + "operationId": "SoftLayer_Security_Certificate::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate/{SoftLayer_Security_CertificateID}/getPemFormat": { + "get": { + "description": "Retrieve the certificate in PEM (Privacy Enhanced Mail) format, which is a string containing all base64 encoded (DER) certificates delimited by -----BEGIN/END *----- clauses. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate/getPemFormat/", + "operationId": "SoftLayer_Security_Certificate::getPemFormat", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate/{SoftLayer_Security_CertificateID}/getAssociatedServiceCount": { + "get": { + "description": "The number of services currently associated with the certificate.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate/getAssociatedServiceCount/", + "operationId": "SoftLayer_Security_Certificate::getAssociatedServiceCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate/{SoftLayer_Security_CertificateID}/getLbaasListeners": { + "get": { + "description": "Cloud Load Balancer [LBaaS] listeners currently associated with the certificate.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate/getLbaasListeners/", + "operationId": "SoftLayer_Security_Certificate::getLbaasListeners", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_LBaaS_Listener" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate/{SoftLayer_Security_CertificateID}/getLoadBalancerVirtualIpAddresses": { + "get": { + "description": "The load balancers virtual IP addresses currently associated with the certificate.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate/getLoadBalancerVirtualIpAddresses/", + "operationId": "SoftLayer_Security_Certificate::getLoadBalancerVirtualIpAddresses", + "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_Security_Certificate_Request/{SoftLayer_Security_Certificate_RequestID}/cancelSslOrder": { + "get": { + "description": "Cancels a pending SSL certificate order at the Certificate Authority ", + "summary": "Cancels a pending SSL certificate order at the Certificate Authority", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/cancelSslOrder/", + "operationId": "SoftLayer_Security_Certificate_Request::cancelSslOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/getAdministratorEmailDomains": { + "post": { + "description": "Gets the email domains that can be used to validate a certificate to a domain. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailDomains/", + "operationId": "SoftLayer_Security_Certificate_Request::getAdministratorEmailDomains", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/getAdministratorEmailPrefixes": { + "get": { + "description": "Gets the email accounts that can be used to validate a certificate to a domain. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailPrefixes/", + "operationId": "SoftLayer_Security_Certificate_Request::getAdministratorEmailPrefixes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/{SoftLayer_Security_Certificate_RequestID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Security_Certificate_Request record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/getObject/", + "operationId": "SoftLayer_Security_Certificate_Request::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/{SoftLayer_Security_Certificate_RequestID}/getPreviousOrderData": { + "get": { + "description": "Returns previous SSL certificate order data. You can use this data for to place a renewal order for a completed SSL certificate. ", + "summary": "Returns previous SSL certificate order data.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/getPreviousOrderData/", + "operationId": "SoftLayer_Security_Certificate_Request::getPreviousOrderData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order_Security_Certificate" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/getSslCertificateRequests": { + "post": { + "description": "Returns all the SSL certificate requests. ", + "summary": "Returns all the SSL certificate requests", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/getSslCertificateRequests/", + "operationId": "SoftLayer_Security_Certificate_Request::getSslCertificateRequests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate_Request" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/{SoftLayer_Security_Certificate_RequestID}/resendEmail": { + "post": { + "description": "A Certificate Authority sends out various emails to your domain administrator or your technical contact. Use this service to have these emails re-sent. ", + "summary": "Have the Certificate Authority send various emails", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/resendEmail/", + "operationId": "SoftLayer_Security_Certificate_Request::resendEmail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/validateCsr": { + "post": { + "description": "Allows you to validate a Certificate Signing Request (CSR) required for an SSL certificate with the certificate authority (CA). This method sends the CSR, the length of the subscription in months, the certificate type, and the server type for validation against requirements of the CA. Returns true if valid. \n\nMore information on CSR generation can be found at: [http://en.wikipedia.org/wiki/Certificate_signing_request Wikipedia] [https://www.digicert.com/csr-creation.htm DigiCert] ", + "summary": "Validates a Certificate Signing Request (CSR) with the certificate authority (CA). ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/validateCsr/", + "operationId": "SoftLayer_Security_Certificate_Request::validateCsr", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/{SoftLayer_Security_Certificate_RequestID}/getAccount": { + "get": { + "description": "The account to which a SSL certificate request belongs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/getAccount/", + "operationId": "SoftLayer_Security_Certificate_Request::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/{SoftLayer_Security_Certificate_RequestID}/getOrder": { + "get": { + "description": "The order contains the information related to a SSL certificate request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/getOrder/", + "operationId": "SoftLayer_Security_Certificate_Request::getOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/{SoftLayer_Security_Certificate_RequestID}/getOrderItem": { + "get": { + "description": "The associated order item for this SSL certificate request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/getOrderItem/", + "operationId": "SoftLayer_Security_Certificate_Request::getOrderItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Order_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request/{SoftLayer_Security_Certificate_RequestID}/getStatus": { + "get": { + "description": "The status of a SSL certificate request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request/getStatus/", + "operationId": "SoftLayer_Security_Certificate_Request::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate_Request_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request_ServerType/getAllObjects": { + "get": { + "description": "Returns all SSL certificate server types, which are passed in on a [[SoftLayer_Container_Product_Order_Security_Certificate|certificate order]]. ", + "summary": "Returns all SSL certificate server types", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getAllObjects/", + "operationId": "SoftLayer_Security_Certificate_Request_ServerType::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate_Request_ServerType" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request_ServerType/{SoftLayer_Security_Certificate_Request_ServerTypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Security_Certificate_Request_ServerType record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getObject/", + "operationId": "SoftLayer_Security_Certificate_Request_ServerType::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate_Request_ServerType" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request_Status/{SoftLayer_Security_Certificate_Request_StatusID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Security_Certificate_Request_Status record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request_Status/getObject/", + "operationId": "SoftLayer_Security_Certificate_Request_Status::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate_Request_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Certificate_Request_Status/getSslRequestStatuses": { + "get": { + "description": "Returns all SSL certificate request status objects ", + "summary": "Returns all SSL certificate request status objects", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Certificate_Request_Status/getSslRequestStatuses/", + "operationId": "SoftLayer_Security_Certificate_Request_Status::getSslRequestStatuses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Certificate_Request_Status" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Ssh_Key/createObject": { + "post": { + "description": "Add a ssh key to your account for use during server provisioning and os reloads. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Ssh_Key/createObject/", + "operationId": "SoftLayer_Security_Ssh_Key::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Ssh_Key/{SoftLayer_Security_Ssh_KeyID}/deleteObject": { + "get": { + "description": "Remove a ssh key from your account. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Ssh_Key/deleteObject/", + "operationId": "SoftLayer_Security_Ssh_Key::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Ssh_Key/{SoftLayer_Security_Ssh_KeyID}/editObject": { + "post": { + "description": "Update a ssh key. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Ssh_Key/editObject/", + "operationId": "SoftLayer_Security_Ssh_Key::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Ssh_Key/{SoftLayer_Security_Ssh_KeyID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Security_Ssh_Key record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Ssh_Key/getObject/", + "operationId": "SoftLayer_Security_Ssh_Key::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Ssh_Key/{SoftLayer_Security_Ssh_KeyID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Ssh_Key/getAccount/", + "operationId": "SoftLayer_Security_Ssh_Key::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Security_Ssh_Key/{SoftLayer_Security_Ssh_KeyID}/getBlockDeviceTemplateGroups": { + "get": { + "description": "The image template groups that are linked to an SSH key.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Ssh_Key/getBlockDeviceTemplateGroups/", + "operationId": "SoftLayer_Security_Ssh_Key::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_Security_Ssh_Key/{SoftLayer_Security_Ssh_KeyID}/getSoftwarePasswords": { + "get": { + "description": "The OS root users that are linked to an SSH key.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Security_Ssh_Key/getSoftwarePasswords/", + "operationId": "SoftLayer_Security_Ssh_Key::getSoftwarePasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_AccountLicense/getAllObjects": { + "get": { + "description": null, + "summary": "Return all account licenses", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_AccountLicense/getAllObjects/", + "operationId": "SoftLayer_Software_AccountLicense::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_AccountLicense" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_AccountLicense/{SoftLayer_Software_AccountLicenseID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Software_AccountLicense record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_AccountLicense/getObject/", + "operationId": "SoftLayer_Software_AccountLicense::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_AccountLicense" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_AccountLicense/{SoftLayer_Software_AccountLicenseID}/getAccount": { + "get": { + "description": "The customer account this Account License belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_AccountLicense/getAccount/", + "operationId": "SoftLayer_Software_AccountLicense::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_AccountLicense/{SoftLayer_Software_AccountLicenseID}/getBillingItem": { + "get": { + "description": "The billing item for a software account license.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_AccountLicense/getBillingItem/", + "operationId": "SoftLayer_Software_AccountLicense::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_AccountLicense/{SoftLayer_Software_AccountLicenseID}/getSoftwareDescription": { + "get": { + "description": "The SoftLayer_Software_Description that this account license is for.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_AccountLicense/getSoftwareDescription/", + "operationId": "SoftLayer_Software_AccountLicense::getSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getLicenseFile": { + "get": { + "description": "Attempt to retrieve the file associated with a software component. If the software component does not support downloading license files an exception will be thrown. ", + "summary": "Get the license file for a software component if it is supported.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getLicenseFile/", + "operationId": "SoftLayer_Software_Component::getLicenseFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Software_Component object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Software_Component service. \n\nThe best way to get software components is through getSoftwareComponents from the Hardware service. ", + "summary": "Retrieve a SoftLayer_Software_Component record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getObject/", + "operationId": "SoftLayer_Software_Component::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getVendorSetUpConfiguration": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getVendorSetUpConfiguration/", + "operationId": "SoftLayer_Software_Component::getVendorSetUpConfiguration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getAverageInstallationDuration": { + "get": { + "description": "The average amount of time that a software component takes to install.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getAverageInstallationDuration/", + "operationId": "SoftLayer_Software_Component::getAverageInstallationDuration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getBillingItem": { + "get": { + "description": "The billing item for a software component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getBillingItem/", + "operationId": "SoftLayer_Software_Component::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getHardware": { + "get": { + "description": "The hardware this Software Component is installed upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getHardware/", + "operationId": "SoftLayer_Software_Component::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getPasswordHistory": { + "get": { + "description": "History Records for Software Passwords.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getPasswordHistory/", + "operationId": "SoftLayer_Software_Component::getPasswordHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getPasswords": { + "get": { + "description": "Username/Password pairs used for access to this Software Installation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getPasswords/", + "operationId": "SoftLayer_Software_Component::getPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getSoftwareDescription": { + "get": { + "description": "The Software Description of this Software Component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getSoftwareDescription/", + "operationId": "SoftLayer_Software_Component::getSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getSoftwareLicense": { + "get": { + "description": "The License this Software Component uses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getSoftwareLicense/", + "operationId": "SoftLayer_Software_Component::getSoftwareLicense", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_License" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component/{SoftLayer_Software_ComponentID}/getVirtualGuest": { + "get": { + "description": "The virtual guest this software component is installed upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component/getVirtualGuest/", + "operationId": "SoftLayer_Software_Component::getVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Software_Component_AntivirusSpyware record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getObject/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_AntivirusSpyware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/updateAntivirusSpywarePolicy": { + "post": { + "description": "Update an anti-virus/spyware policy. The policy options that it accepts are the following: \n*1 - Minimal\n*2 - Relaxed\n*3 - Default\n*4 - High\n*5 - Ultimate", + "summary": "Update an anti-virus/spyware policy.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/updateAntivirusSpywarePolicy/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::updateAntivirusSpywarePolicy", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getLicenseFile": { + "get": { + "description": "Attempt to retrieve the file associated with a software component. If the software component does not support downloading license files an exception will be thrown. ", + "summary": "Get the license file for a software component if it is supported.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getLicenseFile/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getLicenseFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getVendorSetUpConfiguration": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVendorSetUpConfiguration/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getVendorSetUpConfiguration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getAverageInstallationDuration": { + "get": { + "description": "The average amount of time that a software component takes to install.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getAverageInstallationDuration/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getAverageInstallationDuration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getBillingItem": { + "get": { + "description": "The billing item for a software component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getBillingItem/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getHardware": { + "get": { + "description": "The hardware this Software Component is installed upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getHardware/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getPasswordHistory": { + "get": { + "description": "History Records for Software Passwords.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswordHistory/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getPasswordHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getPasswords": { + "get": { + "description": "Username/Password pairs used for access to this Software Installation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswords/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getSoftwareDescription": { + "get": { + "description": "The Software Description of this Software Component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareDescription/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getSoftwareLicense": { + "get": { + "description": "The License this Software Component uses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareLicense/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getSoftwareLicense", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_License" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_AntivirusSpyware/{SoftLayer_Software_Component_AntivirusSpywareID}/getVirtualGuest": { + "get": { + "description": "The virtual guest this software component is installed upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVirtualGuest/", + "operationId": "SoftLayer_Software_Component_AntivirusSpyware::getVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getCurrentHostIpsPolicies": { + "get": { + "description": "Get the current Host IPS policies. ", + "summary": "Get the current Host IPS policies.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getCurrentHostIpsPolicies/", + "operationId": "SoftLayer_Software_Component_HostIps::getCurrentHostIpsPolicies", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Software_Component_HostIps_Policy" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Software_Component_HostIps record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getObject/", + "operationId": "SoftLayer_Software_Component_HostIps::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_HostIps" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/updateHipsPolicies": { + "post": { + "description": "Update the Host IPS policies. To retrieve valid policy options you must use the provided relationships. ", + "summary": "Update the Host IPS policies.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/updateHipsPolicies/", + "operationId": "SoftLayer_Software_Component_HostIps::updateHipsPolicies", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getLicenseFile": { + "get": { + "description": "Attempt to retrieve the file associated with a software component. If the software component does not support downloading license files an exception will be thrown. ", + "summary": "Get the license file for a software component if it is supported.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getLicenseFile/", + "operationId": "SoftLayer_Software_Component_HostIps::getLicenseFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getVendorSetUpConfiguration": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getVendorSetUpConfiguration/", + "operationId": "SoftLayer_Software_Component_HostIps::getVendorSetUpConfiguration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getAverageInstallationDuration": { + "get": { + "description": "The average amount of time that a software component takes to install.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getAverageInstallationDuration/", + "operationId": "SoftLayer_Software_Component_HostIps::getAverageInstallationDuration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getBillingItem": { + "get": { + "description": "The billing item for a software component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getBillingItem/", + "operationId": "SoftLayer_Software_Component_HostIps::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getHardware": { + "get": { + "description": "The hardware this Software Component is installed upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getHardware/", + "operationId": "SoftLayer_Software_Component_HostIps::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getPasswordHistory": { + "get": { + "description": "History Records for Software Passwords.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getPasswordHistory/", + "operationId": "SoftLayer_Software_Component_HostIps::getPasswordHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getPasswords": { + "get": { + "description": "Username/Password pairs used for access to this Software Installation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getPasswords/", + "operationId": "SoftLayer_Software_Component_HostIps::getPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getSoftwareDescription": { + "get": { + "description": "The Software Description of this Software Component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareDescription/", + "operationId": "SoftLayer_Software_Component_HostIps::getSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getSoftwareLicense": { + "get": { + "description": "The License this Software Component uses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareLicense/", + "operationId": "SoftLayer_Software_Component_HostIps::getSoftwareLicense", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_License" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_HostIps/{SoftLayer_Software_Component_HostIpsID}/getVirtualGuest": { + "get": { + "description": "The virtual guest this software component is installed upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_HostIps/getVirtualGuest/", + "operationId": "SoftLayer_Software_Component_HostIps::getVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Password/createObject": { + "post": { + "description": "Create a password for a software component. ", + "summary": "Create a password for a software component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Password/createObject/", + "operationId": "SoftLayer_Software_Component_Password::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Password/createObjects": { + "post": { + "description": "Create more than one password for a software component. ", + "summary": "Create more than one password for a software component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Password/createObjects/", + "operationId": "SoftLayer_Software_Component_Password::createObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Password/{SoftLayer_Software_Component_PasswordID}/deleteObject": { + "get": { + "description": "Delete a password from a software component. ", + "summary": "Delete a password from a software component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Password/deleteObject/", + "operationId": "SoftLayer_Software_Component_Password::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Password/deleteObjects": { + "post": { + "description": "Delete more than one passwords from a software component. ", + "summary": "Delete more than one passwords from a software component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Password/deleteObjects/", + "operationId": "SoftLayer_Software_Component_Password::deleteObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Password/{SoftLayer_Software_Component_PasswordID}/editObject": { + "post": { + "description": "Edit the properties of a software component password such as the username, password, port, and notes. ", + "summary": "Edit the properties of a software component password.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Password/editObject/", + "operationId": "SoftLayer_Software_Component_Password::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Password/editObjects": { + "post": { + "description": "Edit more than one password from a software component. ", + "summary": "Edit more than one password from a software component.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Password/editObjects/", + "operationId": "SoftLayer_Software_Component_Password::editObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Password/{SoftLayer_Software_Component_PasswordID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Software_Component_Password record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Password/getObject/", + "operationId": "SoftLayer_Software_Component_Password::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Password/{SoftLayer_Software_Component_PasswordID}/getSoftware": { + "get": { + "description": "The SoftLayer_Software_Component instance that this username/password pair is valid for.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Password/getSoftware/", + "operationId": "SoftLayer_Software_Component_Password::getSoftware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Password/{SoftLayer_Software_Component_PasswordID}/getSshKeys": { + "get": { + "description": "SSH keys to be installed on the server during provisioning or an OS reload.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Password/getSshKeys/", + "operationId": "SoftLayer_Software_Component_Password::getSshKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getCurrentHostIpsPolicies": { + "get": { + "description": "Get the current Host IPS policies. ", + "summary": "Get the current Host IPS policies.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getCurrentHostIpsPolicies/", + "operationId": "SoftLayer_Software_Component_Trellix::getCurrentHostIpsPolicies", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Software_Component_HostIps_Policy" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Software_Component_Trellix record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getObject/", + "operationId": "SoftLayer_Software_Component_Trellix::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Trellix" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/updateAntivirusSpywarePolicy": { + "post": { + "description": "Update an anti-virus/spyware policy. The policy options that it accepts are the following: \n*1 - Minimal\n*2 - Relaxed\n*3 - Default\n*4 - High\n*5 - Ultimate", + "summary": "Update an anti-virus/spyware policy.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/updateAntivirusSpywarePolicy/", + "operationId": "SoftLayer_Software_Component_Trellix::updateAntivirusSpywarePolicy", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/updateHipsPolicies": { + "post": { + "description": "Update the Host IPS policies. To retrieve valid policy options you must use the provided relationships. ", + "summary": "Update the Host IPS policies.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/updateHipsPolicies/", + "operationId": "SoftLayer_Software_Component_Trellix::updateHipsPolicies", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getLicenseFile": { + "get": { + "description": "Attempt to retrieve the file associated with a software component. If the software component does not support downloading license files an exception will be thrown. ", + "summary": "Get the license file for a software component if it is supported.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getLicenseFile/", + "operationId": "SoftLayer_Software_Component_Trellix::getLicenseFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getVendorSetUpConfiguration": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getVendorSetUpConfiguration/", + "operationId": "SoftLayer_Software_Component_Trellix::getVendorSetUpConfiguration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getAverageInstallationDuration": { + "get": { + "description": "The average amount of time that a software component takes to install.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getAverageInstallationDuration/", + "operationId": "SoftLayer_Software_Component_Trellix::getAverageInstallationDuration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getBillingItem": { + "get": { + "description": "The billing item for a software component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getBillingItem/", + "operationId": "SoftLayer_Software_Component_Trellix::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getHardware": { + "get": { + "description": "The hardware this Software Component is installed upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getHardware/", + "operationId": "SoftLayer_Software_Component_Trellix::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getPasswordHistory": { + "get": { + "description": "History Records for Software Passwords.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getPasswordHistory/", + "operationId": "SoftLayer_Software_Component_Trellix::getPasswordHistory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password_History" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getPasswords": { + "get": { + "description": "Username/Password pairs used for access to this Software Installation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getPasswords/", + "operationId": "SoftLayer_Software_Component_Trellix::getPasswords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_Password" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getSoftwareDescription": { + "get": { + "description": "The Software Description of this Software Component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getSoftwareDescription/", + "operationId": "SoftLayer_Software_Component_Trellix::getSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getSoftwareLicense": { + "get": { + "description": "The License this Software Component uses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getSoftwareLicense/", + "operationId": "SoftLayer_Software_Component_Trellix::getSoftwareLicense", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_License" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Component_Trellix/{SoftLayer_Software_Component_TrellixID}/getVirtualGuest": { + "get": { + "description": "The virtual guest this software component is installed upon.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Component_Trellix/getVirtualGuest/", + "operationId": "SoftLayer_Software_Component_Trellix::getVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getAllObjects/", + "operationId": "SoftLayer_Software_Description::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/getCustomerOwnedLicenseDescriptions": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getCustomerOwnedLicenseDescriptions/", + "operationId": "SoftLayer_Software_Description::getCustomerOwnedLicenseDescriptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Software_Description record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getObject/", + "operationId": "SoftLayer_Software_Description::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getAttributes": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getAttributes/", + "operationId": "SoftLayer_Software_Description::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Description_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getAverageInstallationDuration": { + "get": { + "description": "The average amount of time that a software description takes to install.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getAverageInstallationDuration/", + "operationId": "SoftLayer_Software_Description::getAverageInstallationDuration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getCompatibleSoftwareDescriptions": { + "get": { + "description": "A list of the software descriptions that are compatible with this software description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getCompatibleSoftwareDescriptions/", + "operationId": "SoftLayer_Software_Description::getCompatibleSoftwareDescriptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getFeatures": { + "get": { + "description": "The feature attributes of a software description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getFeatures/", + "operationId": "SoftLayer_Software_Description::getFeatures", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Description_Feature" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getLatestVersion": { + "get": { + "description": "The latest version of a software description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getLatestVersion/", + "operationId": "SoftLayer_Software_Description::getLatestVersion", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getProductItems": { + "get": { + "description": "The various product items to which this software description is linked.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getProductItems/", + "operationId": "SoftLayer_Software_Description::getProductItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getProvisionTransactionGroup": { + "get": { + "description": "This details the provisioning transaction group for this software. This is only valid for Operating System software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getProvisionTransactionGroup/", + "operationId": "SoftLayer_Software_Description::getProvisionTransactionGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getReloadTransactionGroup": { + "get": { + "description": "The transaction group that a software description belongs to. A transaction group is a sequence of transactions that must be performed in a specific order for the installation of software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getReloadTransactionGroup/", + "operationId": "SoftLayer_Software_Description::getReloadTransactionGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getRequiredUser": { + "get": { + "description": "The default user created for a given a software description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getRequiredUser/", + "operationId": "SoftLayer_Software_Description::getRequiredUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getSoftwareLicenses": { + "get": { + "description": "Software Licenses that govern this Software Description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getSoftwareLicenses/", + "operationId": "SoftLayer_Software_Description::getSoftwareLicenses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_License" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getUpgradeSoftwareDescription": { + "get": { + "description": "A suggestion for an upgrade path from this Software Description", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getUpgradeSoftwareDescription/", + "operationId": "SoftLayer_Software_Description::getUpgradeSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getUpgradeSwDesc": { + "get": { + "description": "A suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription)", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getUpgradeSwDesc/", + "operationId": "SoftLayer_Software_Description::getUpgradeSwDesc", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_Description/{SoftLayer_Software_DescriptionID}/getValidFilesystemTypes": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_Description/getValidFilesystemTypes/", + "operationId": "SoftLayer_Software_Description::getValidFilesystemTypes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Filesystem_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_VirtualLicense/{SoftLayer_Software_VirtualLicenseID}/getLicenseFile": { + "get": { + "description": "Attempt to retrieve the file associated with a virtual license, if such a file exists. If there is no file for this virtual license, calling this method will either throw an exception or return false. ", + "summary": "Get the file for a virtual license, if it exists", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_VirtualLicense/getLicenseFile/", + "operationId": "SoftLayer_Software_VirtualLicense::getLicenseFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_VirtualLicense/{SoftLayer_Software_VirtualLicenseID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Software_VirtualLicense object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Software_VirtualLicense service. You can only retrieve Virtual Licenses assigned to your account number. ", + "summary": "Retrieve a SoftLayer_Software_VirtualLicense record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_VirtualLicense/getObject/", + "operationId": "SoftLayer_Software_VirtualLicense::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_VirtualLicense" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_VirtualLicense/{SoftLayer_Software_VirtualLicenseID}/getAccount": { + "get": { + "description": "The customer account this Virtual License belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_VirtualLicense/getAccount/", + "operationId": "SoftLayer_Software_VirtualLicense::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_VirtualLicense/{SoftLayer_Software_VirtualLicenseID}/getBillingItem": { + "get": { + "description": "The billing item for a software virtual license.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_VirtualLicense/getBillingItem/", + "operationId": "SoftLayer_Software_VirtualLicense::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_VirtualLicense/{SoftLayer_Software_VirtualLicenseID}/getHostHardware": { + "get": { + "description": "The hardware record to which the software virtual license is assigned.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_VirtualLicense/getHostHardware/", + "operationId": "SoftLayer_Software_VirtualLicense::getHostHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Server" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_VirtualLicense/{SoftLayer_Software_VirtualLicenseID}/getIpAddressRecord": { + "get": { + "description": "The IP Address record associated with a virtual license.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_VirtualLicense/getIpAddressRecord/", + "operationId": "SoftLayer_Software_VirtualLicense::getIpAddressRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_VirtualLicense/{SoftLayer_Software_VirtualLicenseID}/getSoftwareDescription": { + "get": { + "description": "The SoftLayer_Software_Description that this virtual license is for.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_VirtualLicense/getSoftwareDescription/", + "operationId": "SoftLayer_Software_VirtualLicense::getSoftwareDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Software_VirtualLicense/{SoftLayer_Software_VirtualLicenseID}/getSubnet": { + "get": { + "description": "The subnet this Virtual License's IP address belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Software_VirtualLicense/getSubnet/", + "operationId": "SoftLayer_Software_VirtualLicense::getSubnet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Survey/getActiveSurveyByType": { + "post": { + "description": "Provides survey details for the given type ", + "summary": "Provides survey details for the given type", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Survey/getActiveSurveyByType/", + "operationId": "SoftLayer_Survey::getActiveSurveyByType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Survey" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Survey/{SoftLayer_SurveyID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Survey object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Survey service. You can only retrieve the survey that your portal user has taken. ", + "summary": "Retrieve a SoftLayer_Survey record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Survey/getObject/", + "operationId": "SoftLayer_Survey::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Survey" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Survey/{SoftLayer_SurveyID}/takeSurvey": { + "post": { + "description": "Response to a SoftLayer survey's questions. ", + "summary": "Respond to the questions that a survey has.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Survey/takeSurvey/", + "operationId": "SoftLayer_Survey::takeSurvey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Survey/{SoftLayer_SurveyID}/getQuestions": { + "get": { + "description": "The questions for a survey.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Survey/getQuestions/", + "operationId": "SoftLayer_Survey::getQuestions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Survey_Question" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Survey/{SoftLayer_SurveyID}/getStatus": { + "get": { + "description": "The status of the survey", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Survey/getStatus/", + "operationId": "SoftLayer_Survey::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Survey_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Survey/{SoftLayer_SurveyID}/getType": { + "get": { + "description": "The type of survey", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Survey/getType/", + "operationId": "SoftLayer_Survey::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Survey_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Tag/autoComplete": { + "post": { + "description": "This function is responsible for setting the Tags values. The internal flag is set to 0 if the user is a customer, and 1 otherwise. AccountId is set to the account bound to the user, and the tags name is set to the clean version of the tag inputted by the user. ", + "summary": "Autocomplete tag inputted by a user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Tag/autoComplete/", + "operationId": "SoftLayer_Tag::autoComplete", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Tag/deleteTag": { + "post": { + "description": "Delete a tag for an object. ", + "summary": "delete tag for a given object.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Tag/deleteTag/", + "operationId": "SoftLayer_Tag::deleteTag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Tag/getAllTagTypes": { + "get": { + "description": "Returns all tags of a given object type. ", + "summary": "Get all valid tag types.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Tag/getAllTagTypes/", + "operationId": "SoftLayer_Tag::getAllTagTypes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Tag/getAttachedTagsForCurrentUser": { + "get": { + "description": "Get all tags with at least one reference attached to it for the current account. The total items header for this method contains the total number of attached tags even if a result limit is applied. ", + "summary": "Get the tags attached to references.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Tag/getAttachedTagsForCurrentUser/", + "operationId": "SoftLayer_Tag::getAttachedTagsForCurrentUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Tag/{SoftLayer_TagID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Tag record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Tag/getObject/", + "operationId": "SoftLayer_Tag::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Tag" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Tag/getTagByTagName": { + "post": { + "description": "Returns the Tag object with a given name. The user types in the tag name and this method returns the tag with that name. ", + "summary": "Get the tag object based on what the user inputs.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Tag/getTagByTagName/", + "operationId": "SoftLayer_Tag::getTagByTagName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Tag/getUnattachedTagsForCurrentUser": { + "get": { + "description": "Get all tags with no references attached to it for the current account. The total items header for this method contains the total number of unattached tags even if a result limit is applied. ", + "summary": "Get the tags not attached to references.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Tag/getUnattachedTagsForCurrentUser/", + "operationId": "SoftLayer_Tag::getUnattachedTagsForCurrentUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Tag/setTags": { + "post": { + "description": "Tag an object by passing in one or more tags separated by a comma. Tag references are cleared out every time this method is called. If your object is already tagged you will need to pass the current tags along with any new ones. To remove all tag references pass an empty string. To remove one or more tags omit them from the tag list. The characters permitted are A-Z, 0-9, whitespace, _ (underscore), - (hypen), . (period), and : (colon). All other characters will be stripped away. You must pass 3 string arguments into this method or you will receive an exception. ", + "summary": "Set the tags for a given object.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Tag/setTags/", + "operationId": "SoftLayer_Tag::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Tag/{SoftLayer_TagID}/getAccount": { + "get": { + "description": "The account to which the tag is tied.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Tag/getAccount/", + "operationId": "SoftLayer_Tag::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Tag/{SoftLayer_TagID}/getReferences": { + "get": { + "description": "References that tie object to the tag.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Tag/getReferences/", + "operationId": "SoftLayer_Tag::getReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/addAssignedAgent": { + "post": { + "description": "\n\n", + "summary": "Assign an Agent to a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/addAssignedAgent/", + "operationId": "SoftLayer_Ticket::addAssignedAgent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/addAttachedAdditionalEmails": { + "post": { + "description": "Creates new additional emails for assigned user if new emails are provided. Attaches any newly created additional emails to ticket. ", + "summary": "Add non-user email addresses to a ticket's email notify list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/addAttachedAdditionalEmails/", + "operationId": "SoftLayer_Ticket::addAttachedAdditionalEmails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/addAttachedDedicatedHost": { + "post": { + "description": "Attach the given Dedicated Host to a SoftLayer ticket. An attachment provides an easy way for SoftLayer's employees to quickly look up your records in the case of specific issues. ", + "summary": "Attach a Dedicated Host to a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/addAttachedDedicatedHost/", + "operationId": "SoftLayer_Ticket::addAttachedDedicatedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Attachment_Dedicated_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/addAttachedFile": { + "post": { + "description": "Attach the given file to a SoftLayer ticket. A file attachment is a convenient way to submit non-textual error reports to SoftLayer employees in a ticket. File attachments to tickets must have a unique name. ", + "summary": "Attach a file to a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/addAttachedFile/", + "operationId": "SoftLayer_Ticket::addAttachedFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Attachment_File" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/addAttachedHardware": { + "post": { + "description": "Attach the given hardware to a SoftLayer ticket. A hardware attachment provides an easy way for SoftLayer's employees to quickly look up your hardware records in the case of hardware-specific issues. ", + "summary": "Attach hardware to a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/addAttachedHardware/", + "operationId": "SoftLayer_Ticket::addAttachedHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Attachment_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/addAttachedVirtualGuest": { + "post": { + "description": "Attach the given CloudLayer Computing Instance to a SoftLayer ticket. An attachment provides an easy way for SoftLayer's employees to quickly look up your records in the case of specific issues. ", + "summary": "Attach a CloudLayer Computing Instance to a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/addAttachedVirtualGuest/", + "operationId": "SoftLayer_Ticket::addAttachedVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Attachment_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/addFinalComments": { + "post": { + "description": "As part of the customer service process SoftLayer has provided a quick feedback mechanism for its customers to rate their overall experience with SoftLayer after a ticket is closed. addFinalComments() sets these comments for a ticket update made by a SoftLayer employee. Final comments may only be set on closed tickets, can only be set once, and may not exceed 4000 characters in length. Once the comments are set ''addFinalComments()'' returns a boolean true. ", + "summary": "Add final comments to a closed ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/addFinalComments/", + "operationId": "SoftLayer_Ticket::addFinalComments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/addScheduledAlert": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/addScheduledAlert/", + "operationId": "SoftLayer_Ticket::addScheduledAlert", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/addScheduledAutoClose": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/addScheduledAutoClose/", + "operationId": "SoftLayer_Ticket::addScheduledAutoClose", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/addUpdate": { + "post": { + "description": "Add an update to a ticket. A ticket update's entry has a maximum length of 4000 characters, so ''addUpdate()'' splits the ''entry'' property in the ''templateObject'' parameter into 3900 character blocks and creates one entry per 3900 character block. Once complete ''addUpdate()'' emails the ticket's owner and additional email addresses with an update message if the ticket's ''notifyUserOnUpdateFlag'' is set. If the ticket is a Legal or Abuse ticket, then the account's abuse emails are also notified when the updates are processed. Finally, ''addUpdate()'' returns an array of the newly created ticket updates. ", + "summary": "Add an update to a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/addUpdate/", + "operationId": "SoftLayer_Ticket::addUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Update" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/createAdministrativeTicket": { + "post": { + "description": "Create an administrative support ticket. Use an administrative ticket if you require SoftLayer's assistance managing your server or content. If you are experiencing an issue with SoftLayer's hardware, network, or services then please open a standard support ticket. \n\nSupport tickets may only be created in the open state. The SoftLayer API defaults new ticket properties ''userEditableFlag'' to true, ''accountId'' to the id of the account that your API user belongs to, and ''statusId'' to 1001 (or \"open\"). You may not assign your new to ticket to users that your API user does not have access to. \n\nOnce your ticket is created it is placed in a queue for SoftLayer employees to work. As they update the ticket new [[SoftLayer_Ticket_Update]] entries are added to the ticket object. \n\nAdministrative support tickets add a one-time $3USD charge to your account. ", + "summary": "Create an administrative support ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/createAdministrativeTicket/", + "operationId": "SoftLayer_Ticket::createAdministrativeTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/createCancelServerTicket": { + "post": { + "description": "A cancel server request creates a ticket to cancel the resource on next bill date. The hardware ID parameter is required to determine which server is to be cancelled. NOTE: Hourly bare metal servers will be cancelled on next bill date. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"\n\n\nThe content parameter describes further the reason for cancelling the server. ", + "summary": "Create a sales cancel server ticket to be cancelled on next bill date.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/createCancelServerTicket/", + "operationId": "SoftLayer_Ticket::createCancelServerTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/createCancelServiceTicket": { + "post": { + "description": "A cancel service request creates a sales ticket. The hardware ID parameter is required to determine which server is to be cancelled. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"\n\n\nThe content parameter describes further the reason for cancelling service. ", + "summary": "Create a sales cancel service ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/createCancelServiceTicket/", + "operationId": "SoftLayer_Ticket::createCancelServiceTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/createStandardTicket": { + "post": { + "description": "Create a standard support ticket. Use a standard support ticket if you need to work out a problem related to SoftLayer's hardware, network, or services. If you require SoftLayer's assistance managing your server or content then please open an administrative ticket. \n\nSupport tickets may only be created in the open state. The SoftLayer API defaults new ticket properties ''userEditableFlag'' to true, ''accountId'' to the id of the account that your API user belongs to, and ''statusId'' to 1001 (or \"open\"). You may not assign your new to ticket to users that your API user does not have access to. \n\nOnce your ticket is created it is placed in a queue for SoftLayer employees to work. As they update the ticket new [[SoftLayer_Ticket_Update]] entries are added to the ticket object. ", + "summary": "Create a standard support ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/createStandardTicket/", + "operationId": "SoftLayer_Ticket::createStandardTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/createUpgradeTicket": { + "post": { + "description": "Create a ticket for the SoftLayer sales team to perform a hardware or service upgrade. Our sales team will work with you on upgrade feasibility and pricing and then send the upgrade ticket to the proper department to perform the actual upgrade. Service affecting upgrades, such as server hardware or CloudLayer Computing Instance upgrades that require the server powered down must have a two hour maintenance specified for our datacenter engineers to perform your upgrade. Account level upgrades, such as adding PPTP VPN users, CDNLayer accounts, and monitoring services are processed much faster and do not require a maintenance window. ", + "summary": "Create an upgrade request ticket for the SoftLayer sales team.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/createUpgradeTicket/", + "operationId": "SoftLayer_Ticket::createUpgradeTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/edit": { + "post": { + "description": "Edit a SoftLayer ticket. The edit method is two-fold. You may either edit a ticket itself, add an update to a ticket, attach up to two files to a ticket, or perform all of these tasks. The SoftLayer API ignores changes made to the ''userEditableFlag'' and ''accountId'' properties. You may not assign a ticket to a user that your API account does not have access to. You may not enter a custom title for standard support tickets, buy may do so when editing an administrative ticket. Finally, you may not close a ticket using this method. Please contact SoftLayer if you need a ticket closed. \n\nIf you need to only add an update to a ticket then please use the [[SoftLayer_Ticket::addUpdate|addUpdate]] method in this service. Likewise if you need to only attach a file to a ticket then use the [[SoftLayer_Ticket::addAttachedFile|addAttachedFile]] method. The edit method exists as a convenience if you need to perform all these tasks at once. ", + "summary": "Edit or update a SoftLayer ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/edit/", + "operationId": "SoftLayer_Ticket::edit", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/getAllTicketGroups": { + "get": { + "description": "getAllTicketGroups() retrieves a list of all groups that a ticket may be assigned to. Ticket groups represent the internal department at SoftLayer who a ticket is assigned to. \n\nEvery SoftLayer ticket has groupId and ticketGroup properties that correspond to one of the groups returned by getAllTicketGroups(). ", + "summary": "Retrieve all available ticket groups. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAllTicketGroups/", + "operationId": "SoftLayer_Ticket::getAllTicketGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/getAllTicketStatuses": { + "get": { + "description": "getAllTicketStatuses() retrieves a list of all statuses that a ticket may exist in. Ticket status represent the current state of a ticket, usually \"open\", \"assigned\", and \"closed\". \n\nEvery SoftLayer ticket has statusId and status properties that correspond to one of the statuses returned by getAllTicketStatuses(). ", + "summary": "Retrieve all available ticket statuses. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAllTicketStatuses/", + "operationId": "SoftLayer_Ticket::getAllTicketStatuses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Status" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAttachedFile": { + "post": { + "description": "Retrieve the file attached to a SoftLayer ticket by it's given identifier. To retrieve a list of files attached to a ticket either call the SoftLayer_Ticket::getAttachedFiles method or call SoftLayer_Ticket::getObject with ''attachedFiles'' defined in an object mask. ", + "summary": "Retrieve a file attached to a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAttachedFile/", + "operationId": "SoftLayer_Ticket::getAttachedFile", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Ticket object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Ticket service. You can only retrieve tickets that are associated with your SoftLayer customer account. ", + "summary": "Retrieve a SoftLayer_Ticket record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getObject/", + "operationId": "SoftLayer_Ticket::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/getTicketsClosedSinceDate": { + "post": { + "description": "Retrieve all tickets closed since a given date. ", + "summary": "Retrieve tickets closed since a given date. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getTicketsClosedSinceDate/", + "operationId": "SoftLayer_Ticket::getTicketsClosedSinceDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/markAsViewed": { + "get": { + "description": "Mark a ticket as viewed. All currently posted updates will be marked as viewed. The lastViewedDate property will be updated to the current time. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/markAsViewed/", + "operationId": "SoftLayer_Ticket::markAsViewed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/removeAssignedAgent": { + "post": { + "description": "\n\n", + "summary": "Remove an assigned agent from a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/removeAssignedAgent/", + "operationId": "SoftLayer_Ticket::removeAssignedAgent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/removeAttachedAdditionalEmails": { + "post": { + "description": "removeAttachedAdditionalEmails() removes the specified email addresses from a ticket's notification list. If one of the provided email addresses is not attached to the ticket then ''removeAttachedAdditiaonalEmails()'' ignores it and continues to the next one. Once the email addresses are removed ''removeAttachedAdditiaonalEmails()'' returns a boolean true. ", + "summary": "Detaches non-user additional email addresses from a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/removeAttachedAdditionalEmails/", + "operationId": "SoftLayer_Ticket::removeAttachedAdditionalEmails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/removeAttachedHardware": { + "post": { + "description": "detach the given hardware from a SoftLayer ticket. Removing a hardware attachment may delay ticket processing time if the hardware removed is relevant to the ticket's issue. Return a boolean true upon successful hardware detachment. ", + "summary": "detach hardware from a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/removeAttachedHardware/", + "operationId": "SoftLayer_Ticket::removeAttachedHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/removeAttachedVirtualGuest": { + "post": { + "description": "Detach the given CloudLayer Computing Instance from a SoftLayer ticket. Removing an attachment may delay ticket processing time if the instance removed is relevant to the ticket's issue. Return a boolean true upon successful detachment. ", + "summary": "Detach a CloudLayer Computing Instance from a ticket.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/removeAttachedVirtualGuest/", + "operationId": "SoftLayer_Ticket::removeAttachedVirtualGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/removeScheduledAlert": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/removeScheduledAlert/", + "operationId": "SoftLayer_Ticket::removeScheduledAlert", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/removeScheduledAutoClose": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/removeScheduledAutoClose/", + "operationId": "SoftLayer_Ticket::removeScheduledAutoClose", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/setTags": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/setTags/", + "operationId": "SoftLayer_Ticket::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/surveyEligible": { + "get": { + "description": "(DEPRECATED) Use [[SoftLayer_Ticket_Survey::getPreference]] method. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/surveyEligible/", + "operationId": "SoftLayer_Ticket::surveyEligible", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/updateAttachedAdditionalEmails": { + "post": { + "description": "Creates new additional emails for assigned user if new emails are provided. Attaches any newly created additional emails to ticket. Remove any additional emails from a ticket that are not provided as part of $emails ", + "summary": "Update non-user email addresses attached to a ticket's email notify list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/updateAttachedAdditionalEmails/", + "operationId": "SoftLayer_Ticket::updateAttachedAdditionalEmails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAccount": { + "get": { + "description": "The SoftLayer customer account associated with a ticket.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAccount/", + "operationId": "SoftLayer_Ticket::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAssignedAgents": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAssignedAgents/", + "operationId": "SoftLayer_Ticket::getAssignedAgents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAssignedUser": { + "get": { + "description": "The portal user that a ticket is assigned to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAssignedUser/", + "operationId": "SoftLayer_Ticket::getAssignedUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAttachedAdditionalEmails": { + "get": { + "description": "The list of additional emails to notify when a ticket update is made.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAttachedAdditionalEmails/", + "operationId": "SoftLayer_Ticket::getAttachedAdditionalEmails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_AdditionalEmail" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAttachedDedicatedHosts": { + "get": { + "description": "The Dedicated Hosts associated with a ticket. This is used in cases where a ticket is directly associated with one or more Dedicated Hosts.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAttachedDedicatedHosts/", + "operationId": "SoftLayer_Ticket::getAttachedDedicatedHosts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_DedicatedHost" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAttachedFiles": { + "get": { + "description": "The files attached to a ticket.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAttachedFiles/", + "operationId": "SoftLayer_Ticket::getAttachedFiles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Attachment_File" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAttachedHardware": { + "get": { + "description": "The hardware associated with a ticket. This is used in cases where a ticket is directly associated with one or more pieces of hardware.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAttachedHardware/", + "operationId": "SoftLayer_Ticket::getAttachedHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAttachedHardwareCount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAttachedHardwareCount/", + "operationId": "SoftLayer_Ticket::getAttachedHardwareCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAttachedResources": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAttachedResources/", + "operationId": "SoftLayer_Ticket::getAttachedResources", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Attachment" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAttachedVirtualGuests": { + "get": { + "description": "The virtual guests associated with a ticket. This is used in cases where a ticket is directly associated with one or more virtualized guests installations or Virtual Servers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAttachedVirtualGuests/", + "operationId": "SoftLayer_Ticket::getAttachedVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getAwaitingUserResponseFlag": { + "get": { + "description": "Ticket is waiting on a response from a customer flag.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getAwaitingUserResponseFlag/", + "operationId": "SoftLayer_Ticket::getAwaitingUserResponseFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getBnppSupportedFlag": { + "get": { + "description": "A ticket's associated BNPP compliant record", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getBnppSupportedFlag/", + "operationId": "SoftLayer_Ticket::getBnppSupportedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getCancellationRequest": { + "get": { + "description": "A service cancellation request.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getCancellationRequest/", + "operationId": "SoftLayer_Ticket::getCancellationRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Cancellation_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getEmployeeAttachments": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getEmployeeAttachments/", + "operationId": "SoftLayer_Ticket::getEmployeeAttachments", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Employee" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getEuSupportedFlag": { + "get": { + "description": "A ticket's associated EU compliant record", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getEuSupportedFlag/", + "operationId": "SoftLayer_Ticket::getEuSupportedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getFirstAttachedResource": { + "get": { + "description": "The first physical or virtual server attached to a ticket.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getFirstAttachedResource/", + "operationId": "SoftLayer_Ticket::getFirstAttachedResource", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Attachment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getFirstUpdate": { + "get": { + "description": "The first update made to a ticket. This is typically the contents of a ticket when it's created.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getFirstUpdate/", + "operationId": "SoftLayer_Ticket::getFirstUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Update" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getFsboaSupportedFlag": { + "get": { + "description": "A ticket's associated FSBOA compliant record", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getFsboaSupportedFlag/", + "operationId": "SoftLayer_Ticket::getFsboaSupportedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getGroup": { + "get": { + "description": "The SoftLayer department that a ticket is assigned to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getGroup/", + "operationId": "SoftLayer_Ticket::getGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getInvoiceItems": { + "get": { + "description": "The invoice items associated with a ticket. Ticket based invoice items only exist when a ticket incurs a fee that has been invoiced.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getInvoiceItems/", + "operationId": "SoftLayer_Ticket::getInvoiceItems", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getLastActivity": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getLastActivity/", + "operationId": "SoftLayer_Ticket::getLastActivity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Activity" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getLastEditor": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getLastEditor/", + "operationId": "SoftLayer_Ticket::getLastEditor", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Interface" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getLastUpdate": { + "get": { + "description": "The last update made to a ticket.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getLastUpdate/", + "operationId": "SoftLayer_Ticket::getLastUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Update" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getLocation": { + "get": { + "description": "A ticket's associated location within the SoftLayer location hierarchy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getLocation/", + "operationId": "SoftLayer_Ticket::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getNewUpdatesFlag": { + "get": { + "description": "True if there are new, unread updates to this ticket for the current user, False otherwise.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getNewUpdatesFlag/", + "operationId": "SoftLayer_Ticket::getNewUpdatesFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getScheduledActions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getScheduledActions/", + "operationId": "SoftLayer_Ticket::getScheduledActions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getServerAdministrationBillingInvoice": { + "get": { + "description": "The invoice associated with a ticket. Only tickets with an associated administrative charge have an invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getServerAdministrationBillingInvoice/", + "operationId": "SoftLayer_Ticket::getServerAdministrationBillingInvoice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getServerAdministrationRefundInvoice": { + "get": { + "description": "The refund invoice associated with a ticket. Only tickets with a refund applied in them have an associated refund invoice.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getServerAdministrationRefundInvoice/", + "operationId": "SoftLayer_Ticket::getServerAdministrationRefundInvoice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Invoice" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getServiceProvider": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getServiceProvider/", + "operationId": "SoftLayer_Ticket::getServiceProvider", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Service_Provider" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getState": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getState/", + "operationId": "SoftLayer_Ticket::getState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_State" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getStatus": { + "get": { + "description": "A ticket's status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getStatus/", + "operationId": "SoftLayer_Ticket::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getSubject": { + "get": { + "description": "A ticket's subject. Only standard support tickets have an associated subject. A standard support ticket's title corresponds with it's subject's name.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getSubject/", + "operationId": "SoftLayer_Ticket::getSubject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Subject" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getTagReferences/", + "operationId": "SoftLayer_Ticket::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getUpdateRatingFlag": { + "get": { + "description": "Whether employees' updates of this ticket could be rated by customer", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getUpdateRatingFlag/", + "operationId": "SoftLayer_Ticket::getUpdateRatingFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket/{SoftLayer_TicketID}/getUpdates": { + "get": { + "description": "A ticket's updates.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket/getUpdates/", + "operationId": "SoftLayer_Ticket::getUpdates", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Update" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Attachment_File/getExtensionWhitelist": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Attachment_File/getExtensionWhitelist/", + "operationId": "SoftLayer_Ticket_Attachment_File::getExtensionWhitelist", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Attachment_File/{SoftLayer_Ticket_Attachment_FileID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Ticket_Attachment_File record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Attachment_File/getObject/", + "operationId": "SoftLayer_Ticket_Attachment_File::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Attachment_File" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Attachment_File/{SoftLayer_Ticket_Attachment_FileID}/getTicket": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Attachment_File/getTicket/", + "operationId": "SoftLayer_Ticket_Attachment_File::getTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Attachment_File/{SoftLayer_Ticket_Attachment_FileID}/getUpdate": { + "get": { + "description": "The ticket that a file is attached to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Attachment_File/getUpdate/", + "operationId": "SoftLayer_Ticket_Attachment_File::getUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Update" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Attachment_File_ServiceNow/{SoftLayer_Ticket_Attachment_File_ServiceNowID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Ticket_Attachment_File_ServiceNow record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getObject/", + "operationId": "SoftLayer_Ticket_Attachment_File_ServiceNow::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Attachment_File_ServiceNow" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Attachment_File_ServiceNow/getExtensionWhitelist": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getExtensionWhitelist/", + "operationId": "SoftLayer_Ticket_Attachment_File_ServiceNow::getExtensionWhitelist", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Attachment_File_ServiceNow/{SoftLayer_Ticket_Attachment_File_ServiceNowID}/getTicket": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getTicket/", + "operationId": "SoftLayer_Ticket_Attachment_File_ServiceNow::getTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Attachment_File_ServiceNow/{SoftLayer_Ticket_Attachment_File_ServiceNowID}/getUpdate": { + "get": { + "description": "The ticket that a file is attached to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getUpdate/", + "operationId": "SoftLayer_Ticket_Attachment_File_ServiceNow::getUpdate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Update" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Priority/getPriorities": { + "get": { + "description": null, + "summary": "Obtain a container of valid ticket priority values with value/name key pairs.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Priority/getPriorities/", + "operationId": "SoftLayer_Ticket_Priority::getPriorities", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Ticket_Priority" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Subject/getAllObjects": { + "get": { + "description": "Retrieve all possible ticket subjects. The SoftLayer customer portal uses this method in the add standard support ticket form.", + "summary": "Retrieve all ticket subjects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Subject/getAllObjects/", + "operationId": "SoftLayer_Ticket_Subject::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Subject" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Subject/{SoftLayer_Ticket_SubjectID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Ticket_Subject object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Ticket_Subject service. ", + "summary": "Retrieve a SoftLayer_Ticket_Subject record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Subject/getObject/", + "operationId": "SoftLayer_Ticket_Subject::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Subject" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Subject/{SoftLayer_Ticket_SubjectID}/getTopFiveKnowledgeLayerQuestions": { + "get": { + "description": "SoftLayer maintains relationships between the generic subjects for standard administration and the top five commonly asked questions about these subjects. getTopFileKnowledgeLayerQuestions() retrieves the top five questions and answers from the SoftLayer KnowledgeLayer related to the given ticket subject. ", + "summary": "Retrieve the top five KnowledgeLayer questions for a ticket subject", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Subject/getTopFiveKnowledgeLayerQuestions/", + "operationId": "SoftLayer_Ticket_Subject::getTopFiveKnowledgeLayerQuestions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_KnowledgeLayer_QuestionAnswer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Subject/{SoftLayer_Ticket_SubjectID}/getCategory": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Subject/getCategory/", + "operationId": "SoftLayer_Ticket_Subject::getCategory", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Subject_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Subject/{SoftLayer_Ticket_SubjectID}/getChildren": { + "get": { + "description": "A child subject", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Subject/getChildren/", + "operationId": "SoftLayer_Ticket_Subject::getChildren", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Subject" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Subject/{SoftLayer_Ticket_SubjectID}/getGroup": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Subject/getGroup/", + "operationId": "SoftLayer_Ticket_Subject::getGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Subject/{SoftLayer_Ticket_SubjectID}/getParent": { + "get": { + "description": "A parent subject", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Subject/getParent/", + "operationId": "SoftLayer_Ticket_Subject::getParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Subject" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Subject_Category/getAllObjects": { + "get": { + "description": "Retrieve all ticket subject categories.", + "summary": "Retrieve all ticket subject categories.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Subject_Category/getAllObjects/", + "operationId": "SoftLayer_Ticket_Subject_Category::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Subject_Category" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Subject_Category/{SoftLayer_Ticket_Subject_CategoryID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Ticket_Subject_Category record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Subject_Category/getObject/", + "operationId": "SoftLayer_Ticket_Subject_Category::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Subject_Category" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Subject_Category/{SoftLayer_Ticket_Subject_CategoryID}/getSubjects": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Subject_Category/getSubjects/", + "operationId": "SoftLayer_Ticket_Subject_Category::getSubjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Subject" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Survey/getPreference": { + "get": { + "description": "(DEPRECATED) To opt in or out of future surveys, please follow the link found in the email survey. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Survey/getPreference/", + "operationId": "SoftLayer_Ticket_Survey::getPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Survey/optIn": { + "get": { + "description": "(DEPRECATED) To opt in of future surveys, please follow the link found in the email survey. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Survey/optIn/", + "operationId": "SoftLayer_Ticket_Survey::optIn", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Survey/optOut": { + "get": { + "description": "(DEPRECATED) To opt out of future surveys, please follow the link found in the email survey. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Survey/optOut/", + "operationId": "SoftLayer_Ticket_Survey::optOut", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Update_Employee/{SoftLayer_Ticket_Update_EmployeeID}/addResponseRating": { + "post": { + "description": "As part of the customer service process SoftLayer has provided a quick feedback mechanism for its customers to rate the responses that its employees give on tickets. addResponseRating() sets the rating for a single ticket update made by a SoftLayer employee. Ticket ratings have the integer values 1 through 5, with 1 being the worst and 5 being the best. Once the rating is set ''addResponseRating()'' returns a boolean true. ", + "summary": "Set an update's response rating.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Update_Employee/addResponseRating/", + "operationId": "SoftLayer_Ticket_Update_Employee::addResponseRating", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Update_Employee/{SoftLayer_Ticket_Update_EmployeeID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_Ticket_Update_Employee object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Ticket_Update_Employee service. You can only retrieve employee updates to tickets that your API account has access to. ", + "summary": "Retrieve a SoftLayer_Ticket_Update_Employee record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Update_Employee/getObject/", + "operationId": "SoftLayer_Ticket_Update_Employee::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Update_Employee" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Update_Employee/{SoftLayer_Ticket_Update_EmployeeID}/getChangeOwnerActivity": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Update_Employee/getChangeOwnerActivity/", + "operationId": "SoftLayer_Ticket_Update_Employee::getChangeOwnerActivity", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Update_Employee/{SoftLayer_Ticket_Update_EmployeeID}/getChat": { + "get": { + "description": "The chat between the Customer and Agent", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Update_Employee/getChat/", + "operationId": "SoftLayer_Ticket_Update_Employee::getChat", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Chat_Liveperson" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Update_Employee/{SoftLayer_Ticket_Update_EmployeeID}/getEditor": { + "get": { + "description": "The user or SoftLayer employee who created a ticket update.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Update_Employee/getEditor/", + "operationId": "SoftLayer_Ticket_Update_Employee::getEditor", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Interface" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Update_Employee/{SoftLayer_Ticket_Update_EmployeeID}/getFileAttachment": { + "get": { + "description": "The files attached to a ticket update.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Update_Employee/getFileAttachment/", + "operationId": "SoftLayer_Ticket_Update_Employee::getFileAttachment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Attachment_File" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Update_Employee/{SoftLayer_Ticket_Update_EmployeeID}/getTicket": { + "get": { + "description": "The ticket that a ticket update belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Update_Employee/getTicket/", + "operationId": "SoftLayer_Ticket_Update_Employee::getTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Ticket_Update_Employee/{SoftLayer_Ticket_Update_EmployeeID}/getType": { + "get": { + "description": "The Type of update to this ticket", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Ticket_Update_Employee/getType/", + "operationId": "SoftLayer_Ticket_Update_Employee::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket_Update_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/acknowledgeSupportPolicy": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/acknowledgeSupportPolicy/", + "operationId": "SoftLayer_User_Customer::acknowledgeSupportPolicy", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addApiAuthenticationKey": { + "get": { + "description": "Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key. ", + "summary": "Create a user's API authentication key.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addApiAuthenticationKey/", + "operationId": "SoftLayer_User_Customer::addApiAuthenticationKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addBulkDedicatedHostAccess": { + "post": { + "description": "Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. ", + "summary": "Grant access to the user for one or more dedicated hosts devices.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addBulkDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer::addBulkDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addBulkHardwareAccess": { + "post": { + "description": "Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. ", + "summary": "Add multiple hardware to a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addBulkHardwareAccess/", + "operationId": "SoftLayer_User_Customer::addBulkHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addBulkPortalPermission": { + "post": { + "description": "Add multiple permissions to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user. \n\nUsers can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter. ", + "summary": "Add multiple permissions to a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addBulkPortalPermission/", + "operationId": "SoftLayer_User_Customer::addBulkPortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addBulkRoles": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addBulkRoles/", + "operationId": "SoftLayer_User_Customer::addBulkRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addBulkVirtualGuestAccess": { + "post": { + "description": "Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. ", + "summary": "Add multiple CloudLayer Computing Instances to a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addBulkVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer::addBulkVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addDedicatedHostAccess": { + "post": { + "description": "Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. \n\nOnly the USER_MANAGE permission is required to execute this. ", + "summary": "Grant access to the user for a single dedicated host device.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer::addDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addExternalBinding": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addExternalBinding/", + "operationId": "SoftLayer_User_Customer::addExternalBinding", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_External_Binding" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addHardwareAccess": { + "post": { + "description": "Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. \n\nOnly the USER_MANAGE permission is required to execute this. ", + "summary": "Add hardware to a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addHardwareAccess/", + "operationId": "SoftLayer_User_Customer::addHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addNotificationSubscriber": { + "post": { + "description": "Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive. ", + "summary": "Create a notification subscription record for the user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer::addNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addPortalPermission": { + "post": { + "description": "Add a permission to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true. \n\nUsers can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter. ", + "summary": "Add a permission to a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addPortalPermission/", + "operationId": "SoftLayer_User_Customer::addPortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addRole": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addRole/", + "operationId": "SoftLayer_User_Customer::addRole", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/addVirtualGuestAccess": { + "post": { + "description": "Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. \n\nOnly the USER_MANAGE permission is required to execute this. ", + "summary": "Add a CloudLayer Computing Instance to a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/addVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer::addVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/assignNewParentId": { + "post": { + "description": "This method can be used in place of [[SoftLayer_User_Customer::editObject]] to change the parent user of this user. \n\nThe new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent. \n\nIf the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions. ", + "summary": "Assign a different parent to this user. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/assignNewParentId/", + "operationId": "SoftLayer_User_Customer::assignNewParentId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/changePreference": { + "post": { + "description": "Select a type of preference you would like to modify using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name. ", + "summary": "Change preference values for the current user", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/changePreference/", + "operationId": "SoftLayer_User_Customer::changePreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/createNotificationSubscriber": { + "post": { + "description": "Create a new subscriber for a given resource. ", + "summary": "Create a new subscriber for a given resource.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/createNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer::createNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/createObject": { + "post": { + "description": "Create a new user in the SoftLayer customer portal. It is not possible to set up SLL enable flags during object creation. These flags are ignored during object creation. You will need to make a subsequent call to edit object in order to enable VPN access. \n\nAn account's master user and sub-users who have the User Manage permission can add new users. \n\nUsers are created with a default permission set. After adding a user it may be helpful to set their permissions and device access. \n\nsecondaryPasswordTimeoutDays will be set to the system configured default value if the attribute is not provided or the attribute is not a valid value. \n\nNote, neither password nor vpnPassword parameters are required. \n\nPassword When a new user is created, an email will be sent to the new user's email address with a link to a url that will allow the new user to create or change their password for the SoftLayer customer portal. \n\nIf the password parameter is provided and is not null, then that value will be validated. If it is a valid password, then the user will be created with this password. This user will still receive a portal password email. It can be used within 24 hours to change their password, or it can be allowed to expire, and the password provided during user creation will remain as the user's password. \n\nIf the password parameter is not provided or the value is null, the user must set their portal password using the link sent in email within 24 hours.\u00a0 If the user fails to set their password within 24 hours, then a non-master user can use the \"Reset Password\" link on the login page of the portal to request a new email. A master user can use the link to retrieve a phone number to call to assist in resetting their password. \n\nThe password parameter is ignored for VPN_ONLY users or for IBMid authenticated users. \n\nvpnPassword If the vpnPassword is provided, then the user's vpnPassword will be set to the provided password.\u00a0 When creating a vpn only user, the vpnPassword MUST be supplied.\u00a0 If the vpnPassword is not provided, then the user will need to use the portal to edit their profile and set the vpnPassword. \n\nIBMid considerations When a SoftLayer account is linked to a Platform Services (PaaS, formerly Bluemix) account, AND the trait on the SoftLayer Account indicating IBMid authentication is set, then SoftLayer will delegate the creation of an ACTIVE user to PaaS. This means that even though the request to create a new user in such an account may start at the IMS API, via this delegation we effectively turn it into a request that is driven by PaaS. In particular this means that any \"invitation email\" that comes to the user, will come from PaaS, not from IMS via IBMid. \n\nUsers created in states other than ACTIVE (for example, a VPN_ONLY user) will be created directly in IMS without delegation (but note that no invitation is sent for a user created in any state other than ACTIVE). ", + "summary": "Create a new user record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/createObject/", + "operationId": "SoftLayer_User_Customer::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/createSubscriberDeliveryMethods": { + "post": { + "description": "Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'. ", + "summary": "Create delivery methods for the subscriber.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/createSubscriberDeliveryMethods/", + "operationId": "SoftLayer_User_Customer::createSubscriberDeliveryMethods", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/deactivateNotificationSubscriber": { + "post": { + "description": "Create a new subscriber for a given resource. ", + "summary": "Delete a subscriber for a given resource.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/deactivateNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer::deactivateNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/editObject": { + "post": { + "description": "Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information. ", + "summary": "Update a user's information.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/editObject/", + "operationId": "SoftLayer_User_Customer::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/editObjects": { + "post": { + "description": "Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information. ", + "summary": "Update a collection of users' information", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/editObjects/", + "operationId": "SoftLayer_User_Customer::editObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/findUserPreference": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/findUserPreference/", + "operationId": "SoftLayer_User_Customer::findUserPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/getActiveExternalAuthenticationVendors": { + "get": { + "description": "The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding. ", + "summary": "Get a list of active external authentication vendors for a SoftLayer user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getActiveExternalAuthenticationVendors/", + "operationId": "SoftLayer_User_Customer::getActiveExternalAuthenticationVendors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_External_Binding_Vendor" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getAgentImpersonationToken": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getAgentImpersonationToken/", + "operationId": "SoftLayer_User_Customer::getAgentImpersonationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getAllowedDedicatedHostIds": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getAllowedDedicatedHostIds/", + "operationId": "SoftLayer_User_Customer::getAllowedDedicatedHostIds", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getAllowedHardwareIds": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getAllowedHardwareIds/", + "operationId": "SoftLayer_User_Customer::getAllowedHardwareIds", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getAllowedVirtualGuestIds": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getAllowedVirtualGuestIds/", + "operationId": "SoftLayer_User_Customer::getAllowedVirtualGuestIds", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getAuthenticationToken": { + "post": { + "description": "This method generate user authentication token and return [[SoftLayer_Container_User_Authentication_Token]] object which will be used to authenticate user to login to SoftLayer customer portal. ", + "summary": "Generate a specific type of authentication token", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getAuthenticationToken/", + "operationId": "SoftLayer_User_Customer::getAuthenticationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Authentication_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getDefaultAccount": { + "post": { + "description": "This method is not applicable to legacy SoftLayer-authenticated users and can only be invoked for IBMid-authenticated users. ", + "summary": "This method should never be invoked as it is not applicable to legacy SoftLayer-authenticated users. See SoftLayer_User_Customer_OpenIdConnect::getDefaultAccount instead. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getDefaultAccount/", + "operationId": "SoftLayer_User_Customer::getDefaultAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getHardwareCount": { + "get": { + "description": "Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the \"administrative\" then \"user admin\" links. ", + "summary": "Retrieve the current number of servers a portal user has access to.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getHardwareCount/", + "operationId": "SoftLayer_User_Customer::getHardwareCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getImpersonationToken": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getImpersonationToken/", + "operationId": "SoftLayer_User_Customer::getImpersonationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/getLoginToken": { + "post": { + "description": "Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. ", + "summary": "Authenticate a user for the SoftLayer customer portal", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getLoginToken/", + "operationId": "SoftLayer_User_Customer::getLoginToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Authentication_Response_Common" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getMappedAccounts": { + "post": { + "description": "An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all the accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IBMid-authenticated users. ", + "summary": "Retrieve a list of all the accounts that belong to this customer.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getMappedAccounts/", + "operationId": "SoftLayer_User_Customer::getMappedAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_User_Customer object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer service. You can only retrieve users that are assigned to the customer account belonging to the user making the API call. ", + "summary": "Retrieve a SoftLayer_User_Customer record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getObject/", + "operationId": "SoftLayer_User_Customer::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getOpenIdConnectMigrationState": { + "get": { + "description": "This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown. ", + "summary": "Get the OpenId migration state", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getOpenIdConnectMigrationState/", + "operationId": "SoftLayer_User_Customer::getOpenIdConnectMigrationState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/getPasswordRequirements": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getPasswordRequirements/", + "operationId": "SoftLayer_User_Customer::getPasswordRequirements", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_PasswordSet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/getPortalLoginToken": { + "post": { + "description": "Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. ", + "summary": "Authenticate a user for the SoftLayer customer portal", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getPortalLoginToken/", + "operationId": "SoftLayer_User_Customer::getPortalLoginToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getPreference": { + "post": { + "description": "Select a type of preference you would like to get using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name. ", + "summary": "Get a preference value for the current user", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getPreference/", + "operationId": "SoftLayer_User_Customer::getPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Preference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getPreferenceTypes": { + "get": { + "description": "Use any of the preference types to fetch or modify user preferences using [[SoftLayer_User_Customer::getPreference|getPreference]] or [[SoftLayer_User_Customer::changePreference|changePreference]], respectively. ", + "summary": "Get all available preference types", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getPreferenceTypes/", + "operationId": "SoftLayer_User_Customer::getPreferenceTypes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Preference_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getRequirementsForPasswordSet": { + "post": { + "description": "Retrieve the authentication requirements for an outstanding password set/reset request. The requirements returned in the same SoftLayer_Container_User_Customer_PasswordSet container which is provided as a parameter into this request. The SoftLayer_Container_User_Customer_PasswordSet::authenticationMethods array will contain an entry for each authentication method required for the user. See SoftLayer_Container_User_Customer_PasswordSet for more details. \n\nIf the user has required authentication methods, then authentication information will be supplied to the SoftLayer_User_Customer::processPasswordSetRequest method within this same SoftLayer_Container_User_Customer_PasswordSet container. All existing information in the container must continue to exist in the container to complete the password set/reset process. ", + "summary": "Retrieve the authentication requirements for a user when attempting", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getRequirementsForPasswordSet/", + "operationId": "SoftLayer_User_Customer::getRequirementsForPasswordSet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_PasswordSet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getSupportPolicyDocument": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getSupportPolicyDocument/", + "operationId": "SoftLayer_User_Customer::getSupportPolicyDocument", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getSupportPolicyName": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getSupportPolicyName/", + "operationId": "SoftLayer_User_Customer::getSupportPolicyName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getSupportedLocales": { + "get": { + "description": null, + "summary": "Returns all supported locales for the current user", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getSupportedLocales/", + "operationId": "SoftLayer_User_Customer::getSupportedLocales", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Locale" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/getUserIdForPasswordSet": { + "post": { + "description": "Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request. Password recovery keys are valid for 24 hours after they're generated. \n\nWhen a new user is created or when a user has requested a password change using initiatePortalPasswordChange, they will have received an email that contains a url with a token. That token is used as the parameter for getUserIdForPasswordSet. Once the user id is known, then the SoftLayer_User_Customer object can be retrieved which is necessary to complete the process to set or reset a user's password. ", + "summary": "Retrieve a user id using a password request key", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getUserIdForPasswordSet/", + "operationId": "SoftLayer_User_Customer::getUserIdForPasswordSet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getUserPreferences": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getUserPreferences/", + "operationId": "SoftLayer_User_Customer::getUserPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getVirtualGuestCount": { + "get": { + "description": "Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the \"administrative\" then \"user admin\" links. ", + "summary": "Retrieve the current number of CloudLayer Computing Instances a portal user has access to.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getVirtualGuestCount/", + "operationId": "SoftLayer_User_Customer::getVirtualGuestCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/inTerminalStatus": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/inTerminalStatus/", + "operationId": "SoftLayer_User_Customer::inTerminalStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/initiatePortalPasswordChange": { + "post": { + "description": "Sends password change email to the user containing url that allows the user the change their password. This is the first step when a user wishes to change their password. The url that is generated contains a one-time use token that is valid for only 24-hours. \n\nIf this is a new master user who has never logged into the portal, then password reset will be initiated. Once a master user has logged into the portal, they must setup their security questions prior to logging out because master users are required to answer a security question during the password reset process. Should a master user not have security questions defined and not remember their password in order to define the security questions, then they will need to contact support at live chat or Revenue Services for assistance. \n\nDue to security reasons, the number of reset requests per username are limited within a undisclosed timeframe. ", + "summary": "Request email to allow user to change their password", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChange/", + "operationId": "SoftLayer_User_Customer::initiatePortalPasswordChange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/initiatePortalPasswordChangeByBrandAgent": { + "post": { + "description": "A Brand Agent that has permissions to Add Customer Accounts will be able to request the password email be sent to the Master User of a Customer Account created by the same Brand as the agent making the request. Due to security reasons, the number of reset requests are limited within an undisclosed timeframe. ", + "summary": "Allows a Brand Agent to request password reset email to be sent to", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChangeByBrandAgent/", + "operationId": "SoftLayer_User_Customer::initiatePortalPasswordChangeByBrandAgent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/inviteUserToLinkOpenIdConnect": { + "post": { + "description": "Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error. ", + "summary": "Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/inviteUserToLinkOpenIdConnect/", + "operationId": "SoftLayer_User_Customer::inviteUserToLinkOpenIdConnect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/isMasterUser": { + "get": { + "description": "Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal. ", + "summary": "Determine if a portal user is a master user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/isMasterUser/", + "operationId": "SoftLayer_User_Customer::isMasterUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/isValidPortalPassword": { + "post": { + "description": "Determine if a string is the given user's login password to the SoftLayer customer portal. ", + "summary": "Determine if a string is a user's portal password.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/isValidPortalPassword/", + "operationId": "SoftLayer_User_Customer::isValidPortalPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/performExternalAuthentication": { + "post": { + "description": "The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor. ", + "summary": "Perform an external authentication using the given authentication container. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/performExternalAuthentication/", + "operationId": "SoftLayer_User_Customer::performExternalAuthentication", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/processPasswordSetRequest": { + "post": { + "description": "Set the password for a user who has an outstanding password request. A user with an outstanding password request will have an unused and unexpired password key. The password key is part of the url provided to the user in the email sent to the user with information on how to set their password. The email was generated by the SoftLayer_User_Customer::initiatePortalPasswordRequest request. Password recovery keys are valid for 24 hours after they're generated. \n\nIf the user has required authentication methods as specified by in the SoftLayer_Container_User_Customer_PasswordSet container returned from the SoftLayer_User_Customer::getRequirementsForPasswordSet request, then additional requests must be made to processPasswordSetRequest to authenticate the user before changing the password. First, if the user has security questions set on their profile, they will be required to answer one of their questions correctly. Next, if the user has Verisign or Google Authentication on their account, they must authenticate according to the two-factor provider. All of this authentication is done using the SoftLayer_Container_User_Customer_PasswordSet container. \n\nUser portal passwords must match the following restrictions. Portal passwords must... \n* ...be over eight characters long.\n* ...be under twenty characters long.\n* ...contain at least one uppercase letter\n* ...contain at least one lowercase letter\n* ...contain at least one number\n* ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \\ + =\n* ...not match your username", + "summary": "Set the password for a user who has a valid password request key", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/processPasswordSetRequest/", + "operationId": "SoftLayer_User_Customer::processPasswordSetRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeAllDedicatedHostAccessForThisUser": { + "get": { + "description": "Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. \n\nUsers can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. ", + "summary": "Revoke access to all dedicated hosts on the account for this user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeAllDedicatedHostAccessForThisUser/", + "operationId": "SoftLayer_User_Customer::removeAllDedicatedHostAccessForThisUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeAllHardwareAccessForThisUser": { + "get": { + "description": "Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. \n\nUsers can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. ", + "summary": "Remove all hardware from a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeAllHardwareAccessForThisUser/", + "operationId": "SoftLayer_User_Customer::removeAllHardwareAccessForThisUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeAllVirtualAccessForThisUser": { + "get": { + "description": "Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. \n\nUsers can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. ", + "summary": "Remove all cloud computing instances from a portal user's instance access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeAllVirtualAccessForThisUser/", + "operationId": "SoftLayer_User_Customer::removeAllVirtualAccessForThisUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/removeApiAuthenticationKey": { + "post": { + "description": "Remove a user's API authentication key, removing that user's access to query the SoftLayer API. ", + "summary": "Remove a user's API authentication key.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeApiAuthenticationKey/", + "operationId": "SoftLayer_User_Customer::removeApiAuthenticationKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeBulkDedicatedHostAccess": { + "post": { + "description": "Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. \n\nIf the user has full dedicatedHost access, then it will provide access to \"ALL but passed in\" dedicatedHost ids. ", + "summary": "Revoke access for the user for one or more dedicated hosts devices.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeBulkDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer::removeBulkDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeBulkHardwareAccess": { + "post": { + "description": "Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. \n\nIf the user has full hardware access, then it will provide access to \"ALL but passed in\" hardware ids. ", + "summary": "Remove multiple hardware from a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeBulkHardwareAccess/", + "operationId": "SoftLayer_User_Customer::removeBulkHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeBulkPortalPermission": { + "post": { + "description": "Remove (revoke) multiple permissions from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user. \n\nUsers can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account. \n\nIf the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission. \n\nIf the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter. ", + "summary": "Remove multiple permissions from a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeBulkPortalPermission/", + "operationId": "SoftLayer_User_Customer::removeBulkPortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeBulkRoles": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeBulkRoles/", + "operationId": "SoftLayer_User_Customer::removeBulkRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeBulkVirtualGuestAccess": { + "post": { + "description": "Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account. ", + "summary": "Remove multiple CloudLayer Computing Instances from a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeBulkVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer::removeBulkVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeDedicatedHostAccess": { + "post": { + "description": "Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. ", + "summary": "Revoke access for the user to a single dedicated hosts device.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer::removeDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeExternalBinding": { + "post": { + "description": null, + "summary": "Remove an external binding from this user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeExternalBinding/", + "operationId": "SoftLayer_User_Customer::removeExternalBinding", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeHardwareAccess": { + "post": { + "description": "Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. ", + "summary": "Remove hardware from a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeHardwareAccess/", + "operationId": "SoftLayer_User_Customer::removeHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removePortalPermission": { + "post": { + "description": "Remove (revoke) a permission from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true. \n\nUsers can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. \n\nIf the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission. \n\nIf the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter. ", + "summary": "Remove a permission from a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removePortalPermission/", + "operationId": "SoftLayer_User_Customer::removePortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeRole": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeRole/", + "operationId": "SoftLayer_User_Customer::removeRole", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeSecurityAnswers": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeSecurityAnswers/", + "operationId": "SoftLayer_User_Customer::removeSecurityAnswers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/removeVirtualGuestAccess": { + "post": { + "description": "Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account. ", + "summary": "Remove a CloudLayer Computing Instance from a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/removeVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer::removeVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/resetOpenIdConnectLink": { + "post": { + "description": "This method will change the IBMid that a SoftLayer user is linked to, if we need to do that for some reason. It will do this by modifying the link to the desired new IBMid. NOTE: This method cannot be used to \"un-link\" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is already Bluemix linked. To reset a link for the Bluemix-linked user account, use resetOpenIdConnectLinkUnifiedUserManagementMode. ", + "summary": "Change the link of a user for OpenIdConnect managed accounts, provided the", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLink/", + "operationId": "SoftLayer_User_Customer::resetOpenIdConnectLink", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/resetOpenIdConnectLinkUnifiedUserManagementMode": { + "post": { + "description": "This method will change the IBMid that a SoftLayer master user is linked to, if we need to do that for some reason. It will do this by unlinking the new owner IBMid from its current user association in this account, if there is one (note that the new owner IBMid is not required to already be a member of the IMS account). Then it will modify the existing IBMid link for the master user to use the new owner IBMid-realm IAMid. At this point, if the new owner IBMid isn't already a member of the PaaS account, it will attempt to add it. As a last step, it will call PaaS to modify the owner on that side, if necessary. Only when all those steps are complete, it will commit the IMS-side DB changes. Then, it will clean up the SoftLayer user that was linked to the new owner IBMid (this user became unlinked as the first step in this process). It will also call BSS to delete the old owner IBMid. NOTE: This method cannot be used to \"un-link\" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is not Bluemix linked. To reset a link for the user account not linked to Bluemix, use resetOpenIdConnectLink. ", + "summary": "Change the link of a master user for OpenIdConnect managed accounts,", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLinkUnifiedUserManagementMode/", + "operationId": "SoftLayer_User_Customer::resetOpenIdConnectLinkUnifiedUserManagementMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/samlAuthenticate": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/samlAuthenticate/", + "operationId": "SoftLayer_User_Customer::samlAuthenticate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/samlBeginAuthentication": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/samlBeginAuthentication/", + "operationId": "SoftLayer_User_Customer::samlBeginAuthentication", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/samlBeginLogout": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/samlBeginLogout/", + "operationId": "SoftLayer_User_Customer::samlBeginLogout", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/samlLogout": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/samlLogout/", + "operationId": "SoftLayer_User_Customer::samlLogout", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/selfPasswordChange": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/selfPasswordChange/", + "operationId": "SoftLayer_User_Customer::selfPasswordChange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/setDefaultAccount": { + "post": { + "description": "An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users. ", + "summary": "Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/setDefaultAccount/", + "operationId": "SoftLayer_User_Customer::setDefaultAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/silentlyMigrateUserOpenIdConnect": { + "post": { + "description": "As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail. ", + "summary": "This api is used to migrate a user to IBMid without sending an invitation.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/silentlyMigrateUserOpenIdConnect/", + "operationId": "SoftLayer_User_Customer::silentlyMigrateUserOpenIdConnect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/turnOffMasterUserPermissionCheckMode": { + "get": { + "description": "This method allows the master user of an account to undo the designation of this user as an alternate master user. This can not be applied to the true master user of the account. \n\nNote that this method, by itself, WILL NOT affect the IAM Policies granted this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner turns off an \"alternate/auxiliary master user / account owner\". ", + "summary": "De-activates the behavior that IMS permission checks for this user will be", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/turnOffMasterUserPermissionCheckMode/", + "operationId": "SoftLayer_User_Customer::turnOffMasterUserPermissionCheckMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/turnOnMasterUserPermissionCheckMode": { + "get": { + "description": "This method allows the master user of an account to designate this user as an alternate master user. Effectively this means that this user should have \"all the same IMS permissions as a master user\". \n\nNote that this method, by itself, WILL NOT affect the IAM Policies granted to this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner designates an \"alternate/auxiliary master user / account owner\". ", + "summary": "Activates the behavior that IMS permission checks for this user will be done as though", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/turnOnMasterUserPermissionCheckMode/", + "operationId": "SoftLayer_User_Customer::turnOnMasterUserPermissionCheckMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/updateNotificationSubscriber": { + "post": { + "description": "Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription. ", + "summary": "Update the active status for a notification subscription.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/updateNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer::updateNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/updateSecurityAnswers": { + "post": { + "description": "Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers. ", + "summary": "Update portal login security questions and answers.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/updateSecurityAnswers/", + "operationId": "SoftLayer_User_Customer::updateSecurityAnswers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/updateSubscriberDeliveryMethod": { + "post": { + "description": "Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'. ", + "summary": "Update a delivery method for the subscriber.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/updateSubscriberDeliveryMethod/", + "operationId": "SoftLayer_User_Customer::updateSubscriberDeliveryMethod", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/updateVpnPassword": { + "post": { + "description": "Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN passwords must... \n* ...be over eight characters long.\n* ...be under twenty characters long.\n* ...contain at least one uppercase letter\n* ...contain at least one lowercase letter\n* ...contain at least one number\n* ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \\ =\n* ...not match your username\nFinally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords. ", + "summary": "Update a user's VPN password", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/updateVpnPassword/", + "operationId": "SoftLayer_User_Customer::updateVpnPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/updateVpnUser": { + "get": { + "description": "Always call this function to enable changes when manually configuring VPN subnet access. ", + "summary": "Creates or updates a user's VPN access privileges.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/updateVpnUser/", + "operationId": "SoftLayer_User_Customer::updateVpnUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/validateAuthenticationToken": { + "post": { + "description": "This method validate the given authentication token using the user id by comparing it with the actual user authentication token and return [[SoftLayer_Container_User_Customer_Portal_Token]] object ", + "summary": "Validate the user authentication token", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/validateAuthenticationToken/", + "operationId": "SoftLayer_User_Customer::validateAuthenticationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getAccount": { + "get": { + "description": "The customer account that a user belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getAccount/", + "operationId": "SoftLayer_User_Customer::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getActions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getActions/", + "operationId": "SoftLayer_User_Customer::getActions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Action" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getAdditionalEmails": { + "get": { + "description": "A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getAdditionalEmails/", + "operationId": "SoftLayer_User_Customer::getAdditionalEmails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_AdditionalEmail" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getApiAuthenticationKeys": { + "get": { + "description": "A portal user's API Authentication keys. There is a max limit of one API key per user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getApiAuthenticationKeys/", + "operationId": "SoftLayer_User_Customer::getApiAuthenticationKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_ApiAuthentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getChildUsers": { + "get": { + "description": "A portal user's child users. Some portal users may not have child users.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getChildUsers/", + "operationId": "SoftLayer_User_Customer::getChildUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getClosedTickets": { + "get": { + "description": "An user's associated closed tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getClosedTickets/", + "operationId": "SoftLayer_User_Customer::getClosedTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getDedicatedHosts": { + "get": { + "description": "The dedicated hosts to which the user has been granted access.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getDedicatedHosts/", + "operationId": "SoftLayer_User_Customer::getDedicatedHosts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_DedicatedHost" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getExternalBindings": { + "get": { + "description": "The external authentication bindings that link an external identifier to a SoftLayer user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getExternalBindings/", + "operationId": "SoftLayer_User_Customer::getExternalBindings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getHardware": { + "get": { + "description": "A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getHardware/", + "operationId": "SoftLayer_User_Customer::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getHardwareNotifications": { + "get": { + "description": "Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getHardwareNotifications/", + "operationId": "SoftLayer_User_Customer::getHardwareNotifications", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getHasAcknowledgedSupportPolicyFlag": { + "get": { + "description": "Whether or not a user has acknowledged the support policy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getHasAcknowledgedSupportPolicyFlag/", + "operationId": "SoftLayer_User_Customer::getHasAcknowledgedSupportPolicyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getHasFullDedicatedHostAccessFlag": { + "get": { + "description": "Permission granting the user access to all Dedicated Host devices on the account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getHasFullDedicatedHostAccessFlag/", + "operationId": "SoftLayer_User_Customer::getHasFullDedicatedHostAccessFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getHasFullHardwareAccessFlag": { + "get": { + "description": "Whether or not a portal user has access to all hardware on their account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getHasFullHardwareAccessFlag/", + "operationId": "SoftLayer_User_Customer::getHasFullHardwareAccessFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getHasFullVirtualGuestAccessFlag": { + "get": { + "description": "Whether or not a portal user has access to all virtual guests on their account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getHasFullVirtualGuestAccessFlag/", + "operationId": "SoftLayer_User_Customer::getHasFullVirtualGuestAccessFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getIbmIdLink": { + "get": { + "description": "Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getIbmIdLink/", + "operationId": "SoftLayer_User_Customer::getIbmIdLink", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Link" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getLayoutProfiles": { + "get": { + "description": "Contains the definition of the layout profile.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getLayoutProfiles/", + "operationId": "SoftLayer_User_Customer::getLayoutProfiles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getLocale": { + "get": { + "description": "A user's locale. Locale holds user's language and region information.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getLocale/", + "operationId": "SoftLayer_User_Customer::getLocale", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getLoginAttempts": { + "get": { + "description": "A user's attempts to log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getLoginAttempts/", + "operationId": "SoftLayer_User_Customer::getLoginAttempts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Access_Authentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getNotificationSubscribers": { + "get": { + "description": "Notification subscription records for the user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getNotificationSubscribers/", + "operationId": "SoftLayer_User_Customer::getNotificationSubscribers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Subscriber" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getOpenTickets": { + "get": { + "description": "An user's associated open tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getOpenTickets/", + "operationId": "SoftLayer_User_Customer::getOpenTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getOverrides": { + "get": { + "description": "A portal user's vpn accessible subnets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getOverrides/", + "operationId": "SoftLayer_User_Customer::getOverrides", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Service_Vpn_Overrides" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getParent": { + "get": { + "description": "A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getParent/", + "operationId": "SoftLayer_User_Customer::getParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getPermissions": { + "get": { + "description": "A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getPermissions/", + "operationId": "SoftLayer_User_Customer::getPermissions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_CustomerPermission_Permission" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getPreferences": { + "get": { + "description": "Data type contains a single user preference to a specific preference type.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getPreferences/", + "operationId": "SoftLayer_User_Customer::getPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getRoles": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getRoles/", + "operationId": "SoftLayer_User_Customer::getRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Role" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getSecurityAnswers": { + "get": { + "description": "A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getSecurityAnswers/", + "operationId": "SoftLayer_User_Customer::getSecurityAnswers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Security_Answer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getSubscribers": { + "get": { + "description": "A user's notification subscription records.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getSubscribers/", + "operationId": "SoftLayer_User_Customer::getSubscribers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getSuccessfulLogins": { + "get": { + "description": "A user's successful attempts to log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getSuccessfulLogins/", + "operationId": "SoftLayer_User_Customer::getSuccessfulLogins", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Access_Authentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getSupportPolicyAcknowledgementRequiredFlag": { + "get": { + "description": "Whether or not a user is required to acknowledge the support policy for portal access.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getSupportPolicyAcknowledgementRequiredFlag/", + "operationId": "SoftLayer_User_Customer::getSupportPolicyAcknowledgementRequiredFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getSurveyRequiredFlag": { + "get": { + "description": "Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getSurveyRequiredFlag/", + "operationId": "SoftLayer_User_Customer::getSurveyRequiredFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getSurveys": { + "get": { + "description": "The surveys that a user has taken in the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getSurveys/", + "operationId": "SoftLayer_User_Customer::getSurveys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Survey" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getTickets": { + "get": { + "description": "An user's associated tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getTickets/", + "operationId": "SoftLayer_User_Customer::getTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getTimezone": { + "get": { + "description": "A portal user's time zone.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getTimezone/", + "operationId": "SoftLayer_User_Customer::getTimezone", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale_Timezone" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getUnsuccessfulLogins": { + "get": { + "description": "A user's unsuccessful attempts to log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getUnsuccessfulLogins/", + "operationId": "SoftLayer_User_Customer::getUnsuccessfulLogins", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Access_Authentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getUserLinks": { + "get": { + "description": "User customer link with IBMid and IAMid.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getUserLinks/", + "operationId": "SoftLayer_User_Customer::getUserLinks", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Link" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getUserStatus": { + "get": { + "description": "A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getUserStatus/", + "operationId": "SoftLayer_User_Customer::getUserStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer/{SoftLayer_User_CustomerID}/getVirtualGuests": { + "get": { + "description": "A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer/getVirtualGuests/", + "operationId": "SoftLayer_User_Customer::getVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_ApiAuthentication/{SoftLayer_User_Customer_ApiAuthenticationID}/editObject": { + "post": { + "description": "Edit the properties of customer ApiAuthentication record by passing in a modified instance of a SoftLayer_User_Customer_ApiAuthentication object. Only the ipAddressRestriction property can be modified. ", + "summary": "Edit customer ApiAuthentication record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_ApiAuthentication/editObject/", + "operationId": "SoftLayer_User_Customer_ApiAuthentication::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_ApiAuthentication" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_ApiAuthentication/{SoftLayer_User_Customer_ApiAuthenticationID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_User_Customer_ApiAuthentication object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_ApiAuthentication service. ", + "summary": "Retrieve a SoftLayer_User_Customer_ApiAuthentication record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_ApiAuthentication/getObject/", + "operationId": "SoftLayer_User_Customer_ApiAuthentication::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_ApiAuthentication" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_ApiAuthentication/{SoftLayer_User_Customer_ApiAuthenticationID}/getUser": { + "get": { + "description": "The user who owns the api authentication key.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_ApiAuthentication/getUser/", + "operationId": "SoftLayer_User_Customer_ApiAuthentication::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_CustomerPermission_Permission/getAllObjects": { + "get": { + "description": "Retrieve all available permissions.", + "summary": "Retrieve all available permissions.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getAllObjects/", + "operationId": "SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_CustomerPermission_Permission" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_CustomerPermission_Permission/{SoftLayer_User_Customer_CustomerPermission_PermissionID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_User_Customer_CustomerPermission_Permission object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_CustomerPermission_Permission service. ", + "summary": "Retrieve a SoftLayer_User_Customer_CustomerPermission_Permission record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getObject/", + "operationId": "SoftLayer_User_Customer_CustomerPermission_Permission::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_CustomerPermission_Permission" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/disable": { + "post": { + "description": "Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal. \n\nYou may supply one of the following reason when you disable an external binding: \n*Unspecified\n*TemporarilyUnavailable\n*Lost\n*Stolen", + "summary": "Disable an external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/disable/", + "operationId": "SoftLayer_User_Customer_External_Binding::disable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/enable": { + "get": { + "description": "Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal. \n\nPlease note that API access will be disabled for users that have an active external binding. ", + "summary": "Enable an external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/enable/", + "operationId": "SoftLayer_User_Customer_External_Binding::enable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Customer_External_Binding record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/getObject/", + "operationId": "SoftLayer_User_Customer_External_Binding::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_External_Binding" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/deleteObject": { + "get": { + "description": "Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form. ", + "summary": "Delete an external authentication binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/deleteObject/", + "operationId": "SoftLayer_User_Customer_External_Binding::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/updateNote": { + "post": { + "description": "Update the note of an external binding. The note is an optional property that is used to store information about a binding. ", + "summary": "Update the note of an external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/updateNote/", + "operationId": "SoftLayer_User_Customer_External_Binding::updateNote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/getUser": { + "get": { + "description": "The SoftLayer user that the external authentication binding belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/getUser/", + "operationId": "SoftLayer_User_Customer_External_Binding::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/getAttributes": { + "get": { + "description": "Attributes of an external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/getAttributes/", + "operationId": "SoftLayer_User_Customer_External_Binding::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/getBillingItem": { + "get": { + "description": "Information regarding the billing item for external authentication.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/getBillingItem/", + "operationId": "SoftLayer_User_Customer_External_Binding::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/getNote": { + "get": { + "description": "An optional note for identifying the external binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/getNote/", + "operationId": "SoftLayer_User_Customer_External_Binding::getNote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/getType": { + "get": { + "description": "The type of external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/getType/", + "operationId": "SoftLayer_User_Customer_External_Binding::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding/{SoftLayer_User_Customer_External_BindingID}/getVendor": { + "get": { + "description": "The vendor of an external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding/getVendor/", + "operationId": "SoftLayer_User_Customer_External_Binding::getVendor", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Vendor" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/activate": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/activate/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::activate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/deactivate": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deactivate/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::deactivate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/generateSecretKey": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/generateSecretKey/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::generateSecretKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Customer_External_Binding_Totp record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getObject/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_External_Binding_Totp" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/disable": { + "post": { + "description": "Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal. \n\nYou may supply one of the following reason when you disable an external binding: \n*Unspecified\n*TemporarilyUnavailable\n*Lost\n*Stolen", + "summary": "Disable an external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/disable/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::disable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/enable": { + "get": { + "description": "Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal. \n\nPlease note that API access will be disabled for users that have an active external binding. ", + "summary": "Enable an external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/enable/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::enable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/deleteObject": { + "get": { + "description": "Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form. ", + "summary": "Delete an external authentication binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deleteObject/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/updateNote": { + "post": { + "description": "Update the note of an external binding. The note is an optional property that is used to store information about a binding. ", + "summary": "Update the note of an external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/updateNote/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::updateNote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/getUser": { + "get": { + "description": "The SoftLayer user that the external authentication binding belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getUser/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/getAttributes": { + "get": { + "description": "Attributes of an external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getAttributes/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/getBillingItem": { + "get": { + "description": "Information regarding the billing item for external authentication.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getBillingItem/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/getNote": { + "get": { + "description": "An optional note for identifying the external binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getNote/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::getNote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/getType": { + "get": { + "description": "The type of external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getType/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Totp/{SoftLayer_User_Customer_External_Binding_TotpID}/getVendor": { + "get": { + "description": "The vendor of an external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getVendor/", + "operationId": "SoftLayer_User_Customer_External_Binding_Totp::getVendor", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Vendor" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Vendor/{SoftLayer_User_Customer_External_Binding_VendorID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Customer_External_Binding_Vendor record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getObject/", + "operationId": "SoftLayer_User_Customer_External_Binding_Vendor::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_External_Binding_Vendor" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Vendor/getAllObjects": { + "get": { + "description": "getAllObjects() will return a list of the available external binding vendors that SoftLayer supports. Use this list to select the appropriate vendor when creating a new external binding. ", + "summary": "Get a list of all available external binding vendors that SoftLayer supports.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getAllObjects/", + "operationId": "SoftLayer_User_Customer_External_Binding_Vendor::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Vendor" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/deleteObject": { + "get": { + "description": "Delete a VeriSign external binding. The only VeriSign external binding that can be deleted through this method is the free VeriSign external binding for the master user of a SoftLayer account. All other external bindings must be canceled using the SoftLayer service cancellation form. \n\nWhen a VeriSign external binding is deleted the credential is deactivated in VeriSign's system for use on the SoftLayer site and the $0 billing item associated with the free VeriSign external binding is cancelled. ", + "summary": "Delete a VeriSign external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/deleteObject/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/disable": { + "post": { + "description": "Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal. \n\nYou may supply one of the following reason when you disable an external binding: \n*Unspecified\n*TemporarilyUnavailable\n*Lost\n*Stolen", + "summary": "Disable an external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/disable/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::disable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/enable": { + "get": { + "description": "Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal. \n\nPlease note that API access will be disabled for users that have an active external binding. ", + "summary": "Enable an external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/enable/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::enable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/getActivationCodeForMobileClient": { + "get": { + "description": "An activation code is required when provisioning a new mobile credential from Verisign. This method will return the required activation code. ", + "summary": "Get an activation code that is used for provisioning a mobile credential.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getActivationCodeForMobileClient/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getActivationCodeForMobileClient", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Customer_External_Binding_Verisign record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getObject/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_External_Binding_Verisign" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/unlock": { + "post": { + "description": "If a VeriSign credential becomes locked because of too many failed login attempts the unlock method can be used to unlock a VeriSign credential. As a security precaution a valid security code generated by the credential will be required before the credential is unlocked. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/unlock/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::unlock", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/validateCredentialId": { + "post": { + "description": "Validate the user id and VeriSign credential id used to create an external authentication binding. ", + "summary": "Validate a VeriSign credential id.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/validateCredentialId/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::validateCredentialId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/updateNote": { + "post": { + "description": "Update the note of an external binding. The note is an optional property that is used to store information about a binding. ", + "summary": "Update the note of an external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/updateNote/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::updateNote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getCredentialExpirationDate": { + "get": { + "description": "The date that a VeriSign credential expires.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialExpirationDate/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getCredentialExpirationDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getCredentialLastUpdateDate": { + "get": { + "description": "The last time a VeriSign credential was updated.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialLastUpdateDate/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getCredentialLastUpdateDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getCredentialState": { + "get": { + "description": "The current state of a VeriSign credential. This can be 'Enabled', 'Disabled', or 'Locked'.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialState/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getCredentialState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getCredentialType": { + "get": { + "description": "The type of VeriSign credential. This can be either 'Hardware' or 'Software'.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialType/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getCredentialType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getUser": { + "get": { + "description": "The SoftLayer user that the external authentication binding belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getUser/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getAttributes": { + "get": { + "description": "Attributes of an external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getAttributes/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getBillingItem": { + "get": { + "description": "Information regarding the billing item for external authentication.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getBillingItem/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getNote": { + "get": { + "description": "An optional note for identifying the external binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getNote/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getNote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getType": { + "get": { + "description": "The type of external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getType/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_External_Binding_Verisign/{SoftLayer_User_Customer_External_Binding_VerisignID}/getVendor": { + "get": { + "description": "The vendor of an external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getVendor/", + "operationId": "SoftLayer_User_Customer_External_Binding_Verisign::getVendor", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Vendor" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Invitation/{SoftLayer_User_Customer_InvitationID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Customer_Invitation record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Invitation/getObject/", + "operationId": "SoftLayer_User_Customer_Invitation::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Invitation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Invitation/{SoftLayer_User_Customer_InvitationID}/getUser": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Invitation/getUser/", + "operationId": "SoftLayer_User_Customer_Invitation::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Hardware/createObject": { + "post": { + "description": "Passing in an unsaved instances of a Customer_Notification_Hardware object into this function will create the object and return the results to the user. ", + "summary": "Create a user hardware notification entry", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObject/", + "operationId": "SoftLayer_User_Customer_Notification_Hardware::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Hardware/createObjects": { + "post": { + "description": "Passing in a collection of unsaved instances of Customer_Notification_Hardware objects into this function will create all objects and return the results to the user. ", + "summary": "Create multiple user hardware notification entries at once", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObjects/", + "operationId": "SoftLayer_User_Customer_Notification_Hardware::createObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Hardware/deleteObjects": { + "post": { + "description": "Like any other API object, the customer notification 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 Customer_Notification_Hardware objects by passing in a collection of them", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Hardware/deleteObjects/", + "operationId": "SoftLayer_User_Customer_Notification_Hardware::deleteObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Hardware/findByHardwareId": { + "post": { + "description": "This method returns all Customer_Notification_Hardware 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 monitoringUserNotification on the Hardware_Server object. ", + "summary": "Return all hardware notifications associated with the passed hardware ID", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Hardware/findByHardwareId/", + "operationId": "SoftLayer_User_Customer_Notification_Hardware::findByHardwareId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Hardware/{SoftLayer_User_Customer_Notification_HardwareID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_User_Customer_Notification_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Notification_Hardware service. You can only retrieve hardware notifications attached to hardware and users that belong to your account ", + "summary": "Retrieve a SoftLayer_User_Customer_Notification_Hardware record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Hardware/getObject/", + "operationId": "SoftLayer_User_Customer_Notification_Hardware::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Hardware/{SoftLayer_User_Customer_Notification_HardwareID}/getHardware": { + "get": { + "description": "The hardware object that will be monitored.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Hardware/getHardware/", + "operationId": "SoftLayer_User_Customer_Notification_Hardware::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Hardware/{SoftLayer_User_Customer_Notification_HardwareID}/getUser": { + "get": { + "description": "The user that will be notified when the associated hardware object fails a monitoring instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Hardware/getUser/", + "operationId": "SoftLayer_User_Customer_Notification_Hardware::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Virtual_Guest/createObject": { + "post": { + "description": "Passing in an unsaved instance of a SoftLayer_Customer_Notification_Virtual_Guest object into this function will create the object and return the results to the user. ", + "summary": "Create a user virtual guest notification entry", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObject/", + "operationId": "SoftLayer_User_Customer_Notification_Virtual_Guest::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Virtual_Guest/createObjects": { + "post": { + "description": "Passing in a collection of unsaved instances of SoftLayer_Customer_Notification_Virtual_Guest objects into this function will create all objects and return the results to the user. ", + "summary": "Create multiple user Virtual Guest notification entries at once", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObjects/", + "operationId": "SoftLayer_User_Customer_Notification_Virtual_Guest::createObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Virtual_Guest/deleteObjects": { + "post": { + "description": "Like any other API object, the customer notification 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 SoftLayer_Customer_Notification_Virtual_Guest objects by passing in a collection of them", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/deleteObjects/", + "operationId": "SoftLayer_User_Customer_Notification_Virtual_Guest::deleteObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Virtual_Guest/findByGuestId": { + "post": { + "description": "This method returns all SoftLayer_User_Customer_Notification_Virtual_Guest objects associated with the passed in ID as long as that Virtual Guest ID is owned by the current user's account. \n\nThis behavior can also be accomplished by simply tapping monitoringUserNotification on the Virtual_Guest object. ", + "summary": "Return all CloudLayer computing instance notifications associated with the passed ID", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/findByGuestId/", + "operationId": "SoftLayer_User_Customer_Notification_Virtual_Guest::findByGuestId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Virtual_Guest/{SoftLayer_User_Customer_Notification_Virtual_GuestID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_User_Customer_Notification_Virtual_Guest object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Notification_Virtual_Guest service. You can only retrieve guest notifications attached to virtual guests and users that belong to your account ", + "summary": "Retrieve a SoftLayer_User_Customer_Notification_Virtual_Guest record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getObject/", + "operationId": "SoftLayer_User_Customer_Notification_Virtual_Guest::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Virtual_Guest/{SoftLayer_User_Customer_Notification_Virtual_GuestID}/getGuest": { + "get": { + "description": "The virtual guest object that will be monitored.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getGuest/", + "operationId": "SoftLayer_User_Customer_Notification_Virtual_Guest::getGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Notification_Virtual_Guest/{SoftLayer_User_Customer_Notification_Virtual_GuestID}/getUser": { + "get": { + "description": "The user that will be notified when the associated virtual guest object fails a monitoring instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getUser/", + "operationId": "SoftLayer_User_Customer_Notification_Virtual_Guest::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/activateOpenIdConnectUser": { + "post": { + "description": "Completes invitation process for an OpenIdConnect user created by Bluemix Unified User Console. ", + "summary": "Completes invitation process for an OIDC user initiated by the", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/activateOpenIdConnectUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::activateOpenIdConnectUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/completeInvitationAfterLogin": { + "post": { + "description": null, + "summary": "Completes invitation processing after logging on an existing OpenIdConnect user identity and return an access token", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/completeInvitationAfterLogin/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::completeInvitationAfterLogin", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/createObject": { + "post": { + "description": "Create a new user in the SoftLayer customer portal. It is not possible to set up SLL enable flags during object creation. These flags are ignored during object creation. You will need to make a subsequent call to edit object in order to enable VPN access. \n\nAn account's master user and sub-users who have the User Manage permission can add new users. \n\nUsers are created with a default permission set. After adding a user it may be helpful to set their permissions and device access. \n\nsecondaryPasswordTimeoutDays will be set to the system configured default value if the attribute is not provided or the attribute is not a valid value. \n\nNote, neither password nor vpnPassword parameters are required. \n\nPassword When a new user is created, an email will be sent to the new user's email address with a link to a url that will allow the new user to create or change their password for the SoftLayer customer portal. \n\nIf the password parameter is provided and is not null, then that value will be validated. If it is a valid password, then the user will be created with this password. This user will still receive a portal password email. It can be used within 24 hours to change their password, or it can be allowed to expire, and the password provided during user creation will remain as the user's password. \n\nIf the password parameter is not provided or the value is null, the user must set their portal password using the link sent in email within 24 hours.\u00a0 If the user fails to set their password within 24 hours, then a non-master user can use the \"Reset Password\" link on the login page of the portal to request a new email. A master user can use the link to retrieve a phone number to call to assist in resetting their password. \n\nThe password parameter is ignored for VPN_ONLY users or for IBMid authenticated users. \n\nvpnPassword If the vpnPassword is provided, then the user's vpnPassword will be set to the provided password.\u00a0 When creating a vpn only user, the vpnPassword MUST be supplied.\u00a0 If the vpnPassword is not provided, then the user will need to use the portal to edit their profile and set the vpnPassword. \n\nIBMid considerations When a SoftLayer account is linked to a Platform Services (PaaS, formerly Bluemix) account, AND the trait on the SoftLayer Account indicating IBMid authentication is set, then SoftLayer will delegate the creation of an ACTIVE user to PaaS. This means that even though the request to create a new user in such an account may start at the IMS API, via this delegation we effectively turn it into a request that is driven by PaaS. In particular this means that any \"invitation email\" that comes to the user, will come from PaaS, not from IMS via IBMid. \n\nUsers created in states other than ACTIVE (for example, a VPN_ONLY user) will be created directly in IMS without delegation (but note that no invitation is sent for a user created in any state other than ACTIVE). ", + "summary": "Create a new user record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/createObject/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_OpenIdConnect" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/createOpenIdConnectUserAndCompleteInvitation": { + "post": { + "description": null, + "summary": "Completes invitation processing when a new OpenIdConnect user must be created.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/createOpenIdConnectUserAndCompleteInvitation/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::createOpenIdConnectUserAndCompleteInvitation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/declineInvitation": { + "post": { + "description": "Declines an invitation to link an OpenIdConnect identity to a SoftLayer (Atlas) identity and account. Note that this uses a registration code that is likely a one-time-use-only token, so if an invitation has already been processed (accepted or previously declined) it will not be possible to process it a second time. ", + "summary": "Sets a customer invitation as declined.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/declineInvitation/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::declineInvitation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getDefaultAccount": { + "post": { + "description": "This API gets the account associated with the default user for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. When a single active user is found for that IAMid, it becomes the default user and the associated account is returned. When multiple default users are found only the first is preserved and the associated account is returned (remaining defaults see their default flag unset). If the current SoftLayer user identity isn't linked to any OpenIdConnect identity, or if none of the linked users were found as defaults, the API returns null. Invoke this only on IAMid-authenticated users. ", + "summary": "Retrieve the default account for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDefaultAccount/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getDefaultAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/getLoginAccountInfoOpenIdConnect": { + "post": { + "description": "Validates a supplied OpenIdConnect access token to the SoftLayer customer portal and returns the default account name and id for the active user. An exception will be thrown if no matching customer is found. ", + "summary": "Get account for an active user logging into the SoftLayer customer portal", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAccountInfoOpenIdConnect/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getLoginAccountInfoOpenIdConnect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_OpenIdConnect_LoginAccountInfo" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getMappedAccounts": { + "post": { + "description": "An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all active accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IAMid-authenticated users. ", + "summary": "Retrieve a list of all active accounts that belong to this customer.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMappedAccounts/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getMappedAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Customer_OpenIdConnect record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getObject/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_OpenIdConnect" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/getOpenIdRegistrationInfoFromCode": { + "post": { + "description": null, + "summary": "Get OpenId User Registration details from the provided email code", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdRegistrationInfoFromCode/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getOpenIdRegistrationInfoFromCode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_OpenIdConnect_RegistrationInformation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/getPortalLoginTokenOpenIdConnect": { + "post": { + "description": "Attempt to authenticate a supplied OpenIdConnect access token to the SoftLayer customer portal. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. ", + "summary": "Authenticate a user for the SoftLayer customer portal via an openIdConnect provider.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginTokenOpenIdConnect/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getPortalLoginTokenOpenIdConnect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getRequirementsForPasswordSet": { + "post": { + "description": "Retrieve the authentication requirements for an outstanding password set/reset request. The requirements returned in the same SoftLayer_Container_User_Customer_PasswordSet container which is provided as a parameter into this request. The SoftLayer_Container_User_Customer_PasswordSet::authenticationMethods array will contain an entry for each authentication method required for the user. See SoftLayer_Container_User_Customer_PasswordSet for more details. \n\nIf the user has required authentication methods, then authentication information will be supplied to the SoftLayer_User_Customer::processPasswordSetRequest method within this same SoftLayer_Container_User_Customer_PasswordSet container. All existing information in the container must continue to exist in the container to complete the password set/reset process. ", + "summary": "Retrieve the authentication requirements for a user when attempting", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRequirementsForPasswordSet/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getRequirementsForPasswordSet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_PasswordSet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/getUserForUnifiedInvitation": { + "post": { + "description": "Returns an IMS User Object from the provided OpenIdConnect User ID or IBMid Unique Identifier for the Account of the active user. Enforces the User Management permissions for the Active User. An exception will be thrown if no matching IMS User is found. NOTE that providing IBMid Unique Identifier is optional, but it will be preferred over OpenIdConnect User ID if provided. ", + "summary": "Get the IMS User Object for the provided OpenIdConnect User ID, or (Optional) IBMid Unique Identifier. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserForUnifiedInvitation/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getUserForUnifiedInvitation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_OpenIdConnect" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/getUserIdForPasswordSet": { + "post": { + "description": "Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request. Password recovery keys are valid for 24 hours after they're generated. \n\nWhen a new user is created or when a user has requested a password change using initiatePortalPasswordChange, they will have received an email that contains a url with a token. That token is used as the parameter for getUserIdForPasswordSet. Once the user id is known, then the SoftLayer_User_Customer object can be retrieved which is necessary to complete the process to set or reset a user's password. ", + "summary": "Retrieve a user id using a password request key", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserIdForPasswordSet/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getUserIdForPasswordSet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChange": { + "post": { + "description": "Sends password change email to the user containing url that allows the user the change their password. This is the first step when a user wishes to change their password. The url that is generated contains a one-time use token that is valid for only 24-hours. \n\nIf this is a new master user who has never logged into the portal, then password reset will be initiated. Once a master user has logged into the portal, they must setup their security questions prior to logging out because master users are required to answer a security question during the password reset process. Should a master user not have security questions defined and not remember their password in order to define the security questions, then they will need to contact support at live chat or Revenue Services for assistance. \n\nDue to security reasons, the number of reset requests per username are limited within a undisclosed timeframe. ", + "summary": "Request email to allow user to change their password", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChange/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::initiatePortalPasswordChange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/initiatePortalPasswordChangeByBrandAgent": { + "post": { + "description": "A Brand Agent that has permissions to Add Customer Accounts will be able to request the password email be sent to the Master User of a Customer Account created by the same Brand as the agent making the request. Due to security reasons, the number of reset requests are limited within an undisclosed timeframe. ", + "summary": "Allows a Brand Agent to request password reset email to be sent to", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChangeByBrandAgent/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::initiatePortalPasswordChangeByBrandAgent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/isValidPortalPassword": { + "post": { + "description": "Determine if a string is the given user's login password to the SoftLayer customer portal. ", + "summary": "Determine if a string is a user's portal password.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/isValidPortalPassword/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::isValidPortalPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/processPasswordSetRequest": { + "post": { + "description": "Set the password for a user who has an outstanding password request. A user with an outstanding password request will have an unused and unexpired password key. The password key is part of the url provided to the user in the email sent to the user with information on how to set their password. The email was generated by the SoftLayer_User_Customer::initiatePortalPasswordRequest request. Password recovery keys are valid for 24 hours after they're generated. \n\nIf the user has required authentication methods as specified by in the SoftLayer_Container_User_Customer_PasswordSet container returned from the SoftLayer_User_Customer::getRequirementsForPasswordSet request, then additional requests must be made to processPasswordSetRequest to authenticate the user before changing the password. First, if the user has security questions set on their profile, they will be required to answer one of their questions correctly. Next, if the user has Verisign or Google Authentication on their account, they must authenticate according to the two-factor provider. All of this authentication is done using the SoftLayer_Container_User_Customer_PasswordSet container. \n\nUser portal passwords must match the following restrictions. Portal passwords must... \n* ...be over eight characters long.\n* ...be under twenty characters long.\n* ...contain at least one uppercase letter\n* ...contain at least one lowercase letter\n* ...contain at least one number\n* ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \\ + =\n* ...not match your username", + "summary": "Set the password for a user who has a valid password request key", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/processPasswordSetRequest/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::processPasswordSetRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/selfPasswordChange": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/selfPasswordChange/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::selfPasswordChange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/setDefaultAccount": { + "post": { + "description": "An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users. ", + "summary": "Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/setDefaultAccount/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::setDefaultAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/acknowledgeSupportPolicy": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/acknowledgeSupportPolicy/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::acknowledgeSupportPolicy", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addApiAuthenticationKey": { + "get": { + "description": "Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key. ", + "summary": "Create a user's API authentication key.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addApiAuthenticationKey/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addApiAuthenticationKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addBulkDedicatedHostAccess": { + "post": { + "description": "Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. ", + "summary": "Grant access to the user for one or more dedicated hosts devices.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addBulkDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addBulkHardwareAccess": { + "post": { + "description": "Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. ", + "summary": "Add multiple hardware to a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkHardwareAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addBulkHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addBulkPortalPermission": { + "post": { + "description": "Add multiple permissions to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user. \n\nUsers can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter. ", + "summary": "Add multiple permissions to a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkPortalPermission/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addBulkPortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addBulkRoles": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkRoles/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addBulkRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addBulkVirtualGuestAccess": { + "post": { + "description": "Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. ", + "summary": "Add multiple CloudLayer Computing Instances to a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addBulkVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addDedicatedHostAccess": { + "post": { + "description": "Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. \n\nOnly the USER_MANAGE permission is required to execute this. ", + "summary": "Grant access to the user for a single dedicated host device.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addExternalBinding": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addExternalBinding/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addExternalBinding", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_External_Binding" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addHardwareAccess": { + "post": { + "description": "Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. \n\nOnly the USER_MANAGE permission is required to execute this. ", + "summary": "Add hardware to a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addHardwareAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addNotificationSubscriber": { + "post": { + "description": "Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive. ", + "summary": "Create a notification subscription record for the user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addPortalPermission": { + "post": { + "description": "Add a permission to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true. \n\nUsers can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter. ", + "summary": "Add a permission to a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addPortalPermission/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addPortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addRole": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addRole/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addRole", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/addVirtualGuestAccess": { + "post": { + "description": "Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. \n\nOnly the USER_MANAGE permission is required to execute this. ", + "summary": "Add a CloudLayer Computing Instance to a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/addVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::addVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/assignNewParentId": { + "post": { + "description": "This method can be used in place of [[SoftLayer_User_Customer::editObject]] to change the parent user of this user. \n\nThe new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent. \n\nIf the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions. ", + "summary": "Assign a different parent to this user. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/assignNewParentId/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::assignNewParentId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/changePreference": { + "post": { + "description": "Select a type of preference you would like to modify using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name. ", + "summary": "Change preference values for the current user", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/changePreference/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::changePreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/createNotificationSubscriber": { + "post": { + "description": "Create a new subscriber for a given resource. ", + "summary": "Create a new subscriber for a given resource.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/createNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::createNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/createSubscriberDeliveryMethods": { + "post": { + "description": "Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'. ", + "summary": "Create delivery methods for the subscriber.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/createSubscriberDeliveryMethods/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::createSubscriberDeliveryMethods", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/deactivateNotificationSubscriber": { + "post": { + "description": "Create a new subscriber for a given resource. ", + "summary": "Delete a subscriber for a given resource.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/deactivateNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::deactivateNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/editObject": { + "post": { + "description": "Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information. ", + "summary": "Update a user's information.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObject/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/editObjects": { + "post": { + "description": "Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information. ", + "summary": "Update a collection of users' information", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObjects/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::editObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/findUserPreference": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/findUserPreference/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::findUserPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/getActiveExternalAuthenticationVendors": { + "get": { + "description": "The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding. ", + "summary": "Get a list of active external authentication vendors for a SoftLayer user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActiveExternalAuthenticationVendors/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getActiveExternalAuthenticationVendors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_External_Binding_Vendor" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getAgentImpersonationToken": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAgentImpersonationToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getAgentImpersonationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getAllowedDedicatedHostIds": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedDedicatedHostIds/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getAllowedDedicatedHostIds", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getAllowedHardwareIds": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedHardwareIds/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getAllowedHardwareIds", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getAllowedVirtualGuestIds": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedVirtualGuestIds/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getAllowedVirtualGuestIds", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getAuthenticationToken": { + "post": { + "description": "This method generate user authentication token and return [[SoftLayer_Container_User_Authentication_Token]] object which will be used to authenticate user to login to SoftLayer customer portal. ", + "summary": "Generate a specific type of authentication token", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAuthenticationToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getAuthenticationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Authentication_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getHardwareCount": { + "get": { + "description": "Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the \"administrative\" then \"user admin\" links. ", + "summary": "Retrieve the current number of servers a portal user has access to.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareCount/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getHardwareCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getImpersonationToken": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getImpersonationToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getImpersonationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/getLoginToken": { + "post": { + "description": "Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. ", + "summary": "Authenticate a user for the SoftLayer customer portal", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getLoginToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Authentication_Response_Common" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getOpenIdConnectMigrationState": { + "get": { + "description": "This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown. ", + "summary": "Get the OpenId migration state", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdConnectMigrationState/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getOpenIdConnectMigrationState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/getPasswordRequirements": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPasswordRequirements/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getPasswordRequirements", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_PasswordSet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/getPortalLoginToken": { + "post": { + "description": "Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. ", + "summary": "Authenticate a user for the SoftLayer customer portal", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getPortalLoginToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getPreference": { + "post": { + "description": "Select a type of preference you would like to get using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name. ", + "summary": "Get a preference value for the current user", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreference/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Preference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getPreferenceTypes": { + "get": { + "description": "Use any of the preference types to fetch or modify user preferences using [[SoftLayer_User_Customer::getPreference|getPreference]] or [[SoftLayer_User_Customer::changePreference|changePreference]], respectively. ", + "summary": "Get all available preference types", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferenceTypes/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getPreferenceTypes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Preference_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getSupportPolicyDocument": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyDocument/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getSupportPolicyDocument", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getSupportPolicyName": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyName/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getSupportPolicyName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getSupportedLocales": { + "get": { + "description": null, + "summary": "Returns all supported locales for the current user", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportedLocales/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getSupportedLocales", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Locale" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getUserPreferences": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserPreferences/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getUserPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getVirtualGuestCount": { + "get": { + "description": "Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the \"administrative\" then \"user admin\" links. ", + "summary": "Retrieve the current number of CloudLayer Computing Instances a portal user has access to.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuestCount/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getVirtualGuestCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/inTerminalStatus": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/inTerminalStatus/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::inTerminalStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/inviteUserToLinkOpenIdConnect": { + "post": { + "description": "Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error. ", + "summary": "Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/inviteUserToLinkOpenIdConnect/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::inviteUserToLinkOpenIdConnect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/isMasterUser": { + "get": { + "description": "Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal. ", + "summary": "Determine if a portal user is a master user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/isMasterUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::isMasterUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/performExternalAuthentication": { + "post": { + "description": "The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor. ", + "summary": "Perform an external authentication using the given authentication container. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/performExternalAuthentication/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::performExternalAuthentication", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeAllDedicatedHostAccessForThisUser": { + "get": { + "description": "Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. \n\nUsers can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. ", + "summary": "Revoke access to all dedicated hosts on the account for this user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllDedicatedHostAccessForThisUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeAllDedicatedHostAccessForThisUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeAllHardwareAccessForThisUser": { + "get": { + "description": "Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. \n\nUsers can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. ", + "summary": "Remove all hardware from a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllHardwareAccessForThisUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeAllHardwareAccessForThisUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeAllVirtualAccessForThisUser": { + "get": { + "description": "Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. \n\nUsers can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. ", + "summary": "Remove all cloud computing instances from a portal user's instance access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllVirtualAccessForThisUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeAllVirtualAccessForThisUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/removeApiAuthenticationKey": { + "post": { + "description": "Remove a user's API authentication key, removing that user's access to query the SoftLayer API. ", + "summary": "Remove a user's API authentication key.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeApiAuthenticationKey/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeApiAuthenticationKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeBulkDedicatedHostAccess": { + "post": { + "description": "Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. \n\nIf the user has full dedicatedHost access, then it will provide access to \"ALL but passed in\" dedicatedHost ids. ", + "summary": "Revoke access for the user for one or more dedicated hosts devices.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeBulkDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeBulkHardwareAccess": { + "post": { + "description": "Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. \n\nIf the user has full hardware access, then it will provide access to \"ALL but passed in\" hardware ids. ", + "summary": "Remove multiple hardware from a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkHardwareAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeBulkHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeBulkPortalPermission": { + "post": { + "description": "Remove (revoke) multiple permissions from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user. \n\nUsers can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account. \n\nIf the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission. \n\nIf the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter. ", + "summary": "Remove multiple permissions from a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkPortalPermission/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeBulkPortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeBulkRoles": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkRoles/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeBulkRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeBulkVirtualGuestAccess": { + "post": { + "description": "Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account. ", + "summary": "Remove multiple CloudLayer Computing Instances from a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeBulkVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeDedicatedHostAccess": { + "post": { + "description": "Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. ", + "summary": "Revoke access for the user to a single dedicated hosts device.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeExternalBinding": { + "post": { + "description": null, + "summary": "Remove an external binding from this user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeExternalBinding/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeExternalBinding", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeHardwareAccess": { + "post": { + "description": "Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. ", + "summary": "Remove hardware from a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeHardwareAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removePortalPermission": { + "post": { + "description": "Remove (revoke) a permission from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true. \n\nUsers can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. \n\nIf the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission. \n\nIf the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter. ", + "summary": "Remove a permission from a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removePortalPermission/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removePortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeRole": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeRole/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeRole", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeSecurityAnswers": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeSecurityAnswers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeSecurityAnswers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/removeVirtualGuestAccess": { + "post": { + "description": "Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account. ", + "summary": "Remove a CloudLayer Computing Instance from a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::removeVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/resetOpenIdConnectLink": { + "post": { + "description": "This method will change the IBMid that a SoftLayer user is linked to, if we need to do that for some reason. It will do this by modifying the link to the desired new IBMid. NOTE: This method cannot be used to \"un-link\" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is already Bluemix linked. To reset a link for the Bluemix-linked user account, use resetOpenIdConnectLinkUnifiedUserManagementMode. ", + "summary": "Change the link of a user for OpenIdConnect managed accounts, provided the", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLink/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::resetOpenIdConnectLink", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/resetOpenIdConnectLinkUnifiedUserManagementMode": { + "post": { + "description": "This method will change the IBMid that a SoftLayer master user is linked to, if we need to do that for some reason. It will do this by unlinking the new owner IBMid from its current user association in this account, if there is one (note that the new owner IBMid is not required to already be a member of the IMS account). Then it will modify the existing IBMid link for the master user to use the new owner IBMid-realm IAMid. At this point, if the new owner IBMid isn't already a member of the PaaS account, it will attempt to add it. As a last step, it will call PaaS to modify the owner on that side, if necessary. Only when all those steps are complete, it will commit the IMS-side DB changes. Then, it will clean up the SoftLayer user that was linked to the new owner IBMid (this user became unlinked as the first step in this process). It will also call BSS to delete the old owner IBMid. NOTE: This method cannot be used to \"un-link\" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is not Bluemix linked. To reset a link for the user account not linked to Bluemix, use resetOpenIdConnectLink. ", + "summary": "Change the link of a master user for OpenIdConnect managed accounts,", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLinkUnifiedUserManagementMode/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::resetOpenIdConnectLinkUnifiedUserManagementMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/samlAuthenticate": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlAuthenticate/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::samlAuthenticate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/samlBeginAuthentication": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginAuthentication/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::samlBeginAuthentication", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/samlBeginLogout": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginLogout/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::samlBeginLogout", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/samlLogout": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlLogout/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::samlLogout", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/silentlyMigrateUserOpenIdConnect": { + "post": { + "description": "As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail. ", + "summary": "This api is used to migrate a user to IBMid without sending an invitation.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/silentlyMigrateUserOpenIdConnect/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::silentlyMigrateUserOpenIdConnect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/turnOffMasterUserPermissionCheckMode": { + "get": { + "description": "This method allows the master user of an account to undo the designation of this user as an alternate master user. This can not be applied to the true master user of the account. \n\nNote that this method, by itself, WILL NOT affect the IAM Policies granted this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner turns off an \"alternate/auxiliary master user / account owner\". ", + "summary": "De-activates the behavior that IMS permission checks for this user will be", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/turnOffMasterUserPermissionCheckMode/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::turnOffMasterUserPermissionCheckMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/turnOnMasterUserPermissionCheckMode": { + "get": { + "description": "This method allows the master user of an account to designate this user as an alternate master user. Effectively this means that this user should have \"all the same IMS permissions as a master user\". \n\nNote that this method, by itself, WILL NOT affect the IAM Policies granted to this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner designates an \"alternate/auxiliary master user / account owner\". ", + "summary": "Activates the behavior that IMS permission checks for this user will be done as though", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/turnOnMasterUserPermissionCheckMode/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::turnOnMasterUserPermissionCheckMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/updateNotificationSubscriber": { + "post": { + "description": "Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription. ", + "summary": "Update the active status for a notification subscription.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::updateNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/updateSecurityAnswers": { + "post": { + "description": "Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers. ", + "summary": "Update portal login security questions and answers.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSecurityAnswers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::updateSecurityAnswers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/updateSubscriberDeliveryMethod": { + "post": { + "description": "Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'. ", + "summary": "Update a delivery method for the subscriber.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSubscriberDeliveryMethod/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::updateSubscriberDeliveryMethod", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/updateVpnPassword": { + "post": { + "description": "Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN passwords must... \n* ...be over eight characters long.\n* ...be under twenty characters long.\n* ...contain at least one uppercase letter\n* ...contain at least one lowercase letter\n* ...contain at least one number\n* ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \\ =\n* ...not match your username\nFinally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords. ", + "summary": "Update a user's VPN password", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnPassword/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::updateVpnPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/updateVpnUser": { + "get": { + "description": "Always call this function to enable changes when manually configuring VPN subnet access. ", + "summary": "Creates or updates a user's VPN access privileges.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::updateVpnUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/validateAuthenticationToken": { + "post": { + "description": "This method validate the given authentication token using the user id by comparing it with the actual user authentication token and return [[SoftLayer_Container_User_Customer_Portal_Token]] object ", + "summary": "Validate the user authentication token", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/validateAuthenticationToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::validateAuthenticationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getAccount": { + "get": { + "description": "The customer account that a user belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAccount/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getActions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActions/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getActions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Action" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getAdditionalEmails": { + "get": { + "description": "A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAdditionalEmails/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getAdditionalEmails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_AdditionalEmail" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getApiAuthenticationKeys": { + "get": { + "description": "A portal user's API Authentication keys. There is a max limit of one API key per user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getApiAuthenticationKeys/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getApiAuthenticationKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_ApiAuthentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getChildUsers": { + "get": { + "description": "A portal user's child users. Some portal users may not have child users.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getChildUsers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getChildUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getClosedTickets": { + "get": { + "description": "An user's associated closed tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getClosedTickets/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getClosedTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getDedicatedHosts": { + "get": { + "description": "The dedicated hosts to which the user has been granted access.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDedicatedHosts/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getDedicatedHosts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_DedicatedHost" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getExternalBindings": { + "get": { + "description": "The external authentication bindings that link an external identifier to a SoftLayer user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getExternalBindings/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getExternalBindings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getHardware": { + "get": { + "description": "A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardware/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getHardwareNotifications": { + "get": { + "description": "Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareNotifications/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getHardwareNotifications", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getHasAcknowledgedSupportPolicyFlag": { + "get": { + "description": "Whether or not a user has acknowledged the support policy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasAcknowledgedSupportPolicyFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getHasAcknowledgedSupportPolicyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getHasFullDedicatedHostAccessFlag": { + "get": { + "description": "Permission granting the user access to all Dedicated Host devices on the account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullDedicatedHostAccessFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getHasFullDedicatedHostAccessFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getHasFullHardwareAccessFlag": { + "get": { + "description": "Whether or not a portal user has access to all hardware on their account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullHardwareAccessFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getHasFullHardwareAccessFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getHasFullVirtualGuestAccessFlag": { + "get": { + "description": "Whether or not a portal user has access to all virtual guests on their account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullVirtualGuestAccessFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getHasFullVirtualGuestAccessFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getIbmIdLink": { + "get": { + "description": "Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getIbmIdLink/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getIbmIdLink", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Link" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getLayoutProfiles": { + "get": { + "description": "Contains the definition of the layout profile.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLayoutProfiles/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getLayoutProfiles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getLocale": { + "get": { + "description": "A user's locale. Locale holds user's language and region information.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLocale/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getLocale", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getLoginAttempts": { + "get": { + "description": "A user's attempts to log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAttempts/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getLoginAttempts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Access_Authentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getNotificationSubscribers": { + "get": { + "description": "Notification subscription records for the user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getNotificationSubscribers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getNotificationSubscribers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Subscriber" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getOpenTickets": { + "get": { + "description": "An user's associated open tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenTickets/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getOpenTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getOverrides": { + "get": { + "description": "A portal user's vpn accessible subnets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOverrides/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getOverrides", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Service_Vpn_Overrides" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getParent": { + "get": { + "description": "A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getParent/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getPermissions": { + "get": { + "description": "A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPermissions/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getPermissions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_CustomerPermission_Permission" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getPreferences": { + "get": { + "description": "Data type contains a single user preference to a specific preference type.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferences/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getRoles": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRoles/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Role" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getSecurityAnswers": { + "get": { + "description": "A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSecurityAnswers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getSecurityAnswers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Security_Answer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getSubscribers": { + "get": { + "description": "A user's notification subscription records.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSubscribers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getSubscribers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getSuccessfulLogins": { + "get": { + "description": "A user's successful attempts to log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSuccessfulLogins/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getSuccessfulLogins", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Access_Authentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getSupportPolicyAcknowledgementRequiredFlag": { + "get": { + "description": "Whether or not a user is required to acknowledge the support policy for portal access.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyAcknowledgementRequiredFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getSupportPolicyAcknowledgementRequiredFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getSurveyRequiredFlag": { + "get": { + "description": "Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveyRequiredFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getSurveyRequiredFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getSurveys": { + "get": { + "description": "The surveys that a user has taken in the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveys/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getSurveys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Survey" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getTickets": { + "get": { + "description": "An user's associated tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTickets/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getTimezone": { + "get": { + "description": "A portal user's time zone.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTimezone/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getTimezone", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale_Timezone" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getUnsuccessfulLogins": { + "get": { + "description": "A user's unsuccessful attempts to log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUnsuccessfulLogins/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getUnsuccessfulLogins", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Access_Authentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getUserLinks": { + "get": { + "description": "User customer link with IBMid and IAMid.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserLinks/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getUserLinks", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Link" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getUserStatus": { + "get": { + "description": "A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserStatus/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getUserStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect/{SoftLayer_User_Customer_OpenIdConnectID}/getVirtualGuests": { + "get": { + "description": "A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuests/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect::getVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addApiAuthenticationKey": { + "get": { + "description": "Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key. ", + "summary": "Create a user's API authentication key.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addApiAuthenticationKey/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addApiAuthenticationKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addExternalBinding": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addExternalBinding/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addExternalBinding", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_External_Binding" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createObject/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginToken": { + "post": { + "description": "Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. ", + "summary": "Authenticate a user for the SoftLayer customer portal", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getLoginToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Authentication_Response_Common" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Customer_OpenIdConnect_TrustedProfile record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getObject/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getRequirementsForPasswordSet": { + "post": { + "description": "Retrieve the authentication requirements for an outstanding password set/reset request. The requirements returned in the same SoftLayer_Container_User_Customer_PasswordSet container which is provided as a parameter into this request. The SoftLayer_Container_User_Customer_PasswordSet::authenticationMethods array will contain an entry for each authentication method required for the user. See SoftLayer_Container_User_Customer_PasswordSet for more details. \n\nIf the user has required authentication methods, then authentication information will be supplied to the SoftLayer_User_Customer::processPasswordSetRequest method within this same SoftLayer_Container_User_Customer_PasswordSet container. All existing information in the container must continue to exist in the container to complete the password set/reset process. ", + "summary": "Retrieve the authentication requirements for a user when attempting", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRequirementsForPasswordSet/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getRequirementsForPasswordSet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_PasswordSet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserIdForPasswordSet": { + "post": { + "description": "Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request. Password recovery keys are valid for 24 hours after they're generated. \n\nWhen a new user is created or when a user has requested a password change using initiatePortalPasswordChange, they will have received an email that contains a url with a token. That token is used as the parameter for getUserIdForPasswordSet. Once the user id is known, then the SoftLayer_User_Customer object can be retrieved which is necessary to complete the process to set or reset a user's password. ", + "summary": "Retrieve a user id using a password request key", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserIdForPasswordSet/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getUserIdForPasswordSet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChange": { + "post": { + "description": "Sends password change email to the user containing url that allows the user the change their password. This is the first step when a user wishes to change their password. The url that is generated contains a one-time use token that is valid for only 24-hours. \n\nIf this is a new master user who has never logged into the portal, then password reset will be initiated. Once a master user has logged into the portal, they must setup their security questions prior to logging out because master users are required to answer a security question during the password reset process. Should a master user not have security questions defined and not remember their password in order to define the security questions, then they will need to contact support at live chat or Revenue Services for assistance. \n\nDue to security reasons, the number of reset requests per username are limited within a undisclosed timeframe. ", + "summary": "Request email to allow user to change their password", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChange/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::initiatePortalPasswordChange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/initiatePortalPasswordChangeByBrandAgent": { + "post": { + "description": "A Brand Agent that has permissions to Add Customer Accounts will be able to request the password email be sent to the Master User of a Customer Account created by the same Brand as the agent making the request. Due to security reasons, the number of reset requests are limited within an undisclosed timeframe. ", + "summary": "Allows a Brand Agent to request password reset email to be sent to", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChangeByBrandAgent/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::initiatePortalPasswordChangeByBrandAgent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/isValidPortalPassword": { + "post": { + "description": "Determine if a string is the given user's login password to the SoftLayer customer portal. ", + "summary": "Determine if a string is a user's portal password.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isValidPortalPassword/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::isValidPortalPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/processPasswordSetRequest": { + "post": { + "description": "Set the password for a user who has an outstanding password request. A user with an outstanding password request will have an unused and unexpired password key. The password key is part of the url provided to the user in the email sent to the user with information on how to set their password. The email was generated by the SoftLayer_User_Customer::initiatePortalPasswordRequest request. Password recovery keys are valid for 24 hours after they're generated. \n\nIf the user has required authentication methods as specified by in the SoftLayer_Container_User_Customer_PasswordSet container returned from the SoftLayer_User_Customer::getRequirementsForPasswordSet request, then additional requests must be made to processPasswordSetRequest to authenticate the user before changing the password. First, if the user has security questions set on their profile, they will be required to answer one of their questions correctly. Next, if the user has Verisign or Google Authentication on their account, they must authenticate according to the two-factor provider. All of this authentication is done using the SoftLayer_Container_User_Customer_PasswordSet container. \n\nUser portal passwords must match the following restrictions. Portal passwords must... \n* ...be over eight characters long.\n* ...be under twenty characters long.\n* ...contain at least one uppercase letter\n* ...contain at least one lowercase letter\n* ...contain at least one number\n* ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \\ + =\n* ...not match your username", + "summary": "Set the password for a user who has a valid password request key", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/processPasswordSetRequest/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::processPasswordSetRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/turnOffMasterUserPermissionCheckMode": { + "get": { + "description": "This method allows the master user of an account to undo the designation of this user as an alternate master user. This can not be applied to the true master user of the account. \n\nNote that this method, by itself, WILL NOT affect the IAM Policies granted this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner turns off an \"alternate/auxiliary master user / account owner\". ", + "summary": "De-activates the behavior that IMS permission checks for this user will be done as though this was the master user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/turnOffMasterUserPermissionCheckMode/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::turnOffMasterUserPermissionCheckMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/turnOnMasterUserPermissionCheckMode": { + "get": { + "description": "This method allows the master user of an account to designate this user as an alternate master user. Effectively this means that this user should have \"all the same IMS permissions as a master user\". \n\nNote that this method, by itself, WILL NOT affect the IAM Policies granted to this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner designates an \"alternate/auxiliary master user / account owner\". ", + "summary": "Activates the behavior that IMS permission checks for this user will be done as though this was the master user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/turnOnMasterUserPermissionCheckMode/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::turnOnMasterUserPermissionCheckMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/updateVpnUser": { + "get": { + "description": "Always call this function to enable changes when manually configuring VPN subnet access. ", + "summary": "Creates or updates a user's VPN access privileges.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::updateVpnUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/activateOpenIdConnectUser": { + "post": { + "description": "Completes invitation process for an OpenIdConnect user created by Bluemix Unified User Console. ", + "summary": "Completes invitation process for an OIDC user initiated by the", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/activateOpenIdConnectUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::activateOpenIdConnectUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/completeInvitationAfterLogin": { + "post": { + "description": null, + "summary": "Completes invitation processing after logging on an existing OpenIdConnect user identity and return an access token", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/completeInvitationAfterLogin/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::completeInvitationAfterLogin", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createOpenIdConnectUserAndCompleteInvitation": { + "post": { + "description": null, + "summary": "Completes invitation processing when a new OpenIdConnect user must be created.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createOpenIdConnectUserAndCompleteInvitation/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::createOpenIdConnectUserAndCompleteInvitation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/declineInvitation": { + "post": { + "description": "Declines an invitation to link an OpenIdConnect identity to a SoftLayer (Atlas) identity and account. Note that this uses a registration code that is likely a one-time-use-only token, so if an invitation has already been processed (accepted or previously declined) it will not be possible to process it a second time. ", + "summary": "Sets a customer invitation as declined.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/declineInvitation/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::declineInvitation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getDefaultAccount": { + "post": { + "description": "This API gets the account associated with the default user for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. When a single active user is found for that IAMid, it becomes the default user and the associated account is returned. When multiple default users are found only the first is preserved and the associated account is returned (remaining defaults see their default flag unset). If the current SoftLayer user identity isn't linked to any OpenIdConnect identity, or if none of the linked users were found as defaults, the API returns null. Invoke this only on IAMid-authenticated users. ", + "summary": "Retrieve the default account for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDefaultAccount/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getDefaultAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAccountInfoOpenIdConnect": { + "post": { + "description": "Validates a supplied OpenIdConnect access token to the SoftLayer customer portal and returns the default account name and id for the active user. An exception will be thrown if no matching customer is found. ", + "summary": "Get account for an active user logging into the SoftLayer customer portal", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAccountInfoOpenIdConnect/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getLoginAccountInfoOpenIdConnect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_OpenIdConnect_LoginAccountInfo" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getMappedAccounts": { + "post": { + "description": "An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all active accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IAMid-authenticated users. ", + "summary": "Retrieve a list of all active accounts that belong to this customer.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMappedAccounts/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getMappedAccounts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdRegistrationInfoFromCode": { + "post": { + "description": null, + "summary": "Get OpenId User Registration details from the provided email code", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdRegistrationInfoFromCode/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getOpenIdRegistrationInfoFromCode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account_Authentication_OpenIdConnect_RegistrationInformation" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginTokenOpenIdConnect": { + "post": { + "description": "Attempt to authenticate a supplied OpenIdConnect access token to the SoftLayer customer portal. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. ", + "summary": "Authenticate a user for the SoftLayer customer portal via an openIdConnect provider.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginTokenOpenIdConnect/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getPortalLoginTokenOpenIdConnect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserForUnifiedInvitation": { + "post": { + "description": "Returns an IMS User Object from the provided OpenIdConnect User ID or IBMid Unique Identifier for the Account of the active user. Enforces the User Management permissions for the Active User. An exception will be thrown if no matching IMS User is found. NOTE that providing IBMid Unique Identifier is optional, but it will be preferred over OpenIdConnect User ID if provided. ", + "summary": "Get the IMS User Object for the provided OpenIdConnect User ID, or (Optional) IBMid Unique Identifier. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserForUnifiedInvitation/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getUserForUnifiedInvitation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_OpenIdConnect" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/selfPasswordChange": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/selfPasswordChange/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::selfPasswordChange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/setDefaultAccount": { + "post": { + "description": "An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users. ", + "summary": "Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/setDefaultAccount/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::setDefaultAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/acknowledgeSupportPolicy": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/acknowledgeSupportPolicy/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::acknowledgeSupportPolicy", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addBulkDedicatedHostAccess": { + "post": { + "description": "Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. ", + "summary": "Grant access to the user for one or more dedicated hosts devices.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addBulkDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addBulkHardwareAccess": { + "post": { + "description": "Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. ", + "summary": "Add multiple hardware to a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkHardwareAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addBulkHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addBulkPortalPermission": { + "post": { + "description": "Add multiple permissions to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user. \n\nUsers can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter. ", + "summary": "Add multiple permissions to a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkPortalPermission/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addBulkPortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addBulkRoles": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkRoles/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addBulkRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addBulkVirtualGuestAccess": { + "post": { + "description": "Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. ", + "summary": "Add multiple CloudLayer Computing Instances to a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addBulkVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addDedicatedHostAccess": { + "post": { + "description": "Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. \n\nOnly the USER_MANAGE permission is required to execute this. ", + "summary": "Grant access to the user for a single dedicated host device.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addHardwareAccess": { + "post": { + "description": "Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. \n\nOnly the USER_MANAGE permission is required to execute this. ", + "summary": "Add hardware to a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addHardwareAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addNotificationSubscriber": { + "post": { + "description": "Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive. ", + "summary": "Create a notification subscription record for the user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addPortalPermission": { + "post": { + "description": "Add a permission to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true. \n\nUsers can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter. ", + "summary": "Add a permission to a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addPortalPermission/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addPortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addRole": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addRole/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addRole", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/addVirtualGuestAccess": { + "post": { + "description": "Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. \n\nOnly the USER_MANAGE permission is required to execute this. ", + "summary": "Add a CloudLayer Computing Instance to a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/assignNewParentId": { + "post": { + "description": "This method can be used in place of [[SoftLayer_User_Customer::editObject]] to change the parent user of this user. \n\nThe new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent. \n\nIf the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions. ", + "summary": "Assign a different parent to this user. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/assignNewParentId/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::assignNewParentId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/changePreference": { + "post": { + "description": "Select a type of preference you would like to modify using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name. ", + "summary": "Change preference values for the current user", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/changePreference/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::changePreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/createNotificationSubscriber": { + "post": { + "description": "Create a new subscriber for a given resource. ", + "summary": "Create a new subscriber for a given resource.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::createNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/createSubscriberDeliveryMethods": { + "post": { + "description": "Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'. ", + "summary": "Create delivery methods for the subscriber.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createSubscriberDeliveryMethods/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::createSubscriberDeliveryMethods", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/deactivateNotificationSubscriber": { + "post": { + "description": "Create a new subscriber for a given resource. ", + "summary": "Delete a subscriber for a given resource.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/deactivateNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::deactivateNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/editObject": { + "post": { + "description": "Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information. ", + "summary": "Update a user's information.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObject/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObjects": { + "post": { + "description": "Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information. ", + "summary": "Update a collection of users' information", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObjects/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::editObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/findUserPreference": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/findUserPreference/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::findUserPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActiveExternalAuthenticationVendors": { + "get": { + "description": "The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding. ", + "summary": "Get a list of active external authentication vendors for a SoftLayer user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActiveExternalAuthenticationVendors/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getActiveExternalAuthenticationVendors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_External_Binding_Vendor" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getAgentImpersonationToken": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAgentImpersonationToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getAgentImpersonationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getAllowedDedicatedHostIds": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedDedicatedHostIds/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getAllowedDedicatedHostIds", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getAllowedHardwareIds": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedHardwareIds/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getAllowedHardwareIds", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getAllowedVirtualGuestIds": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedVirtualGuestIds/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getAllowedVirtualGuestIds", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "int" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getAuthenticationToken": { + "post": { + "description": "This method generate user authentication token and return [[SoftLayer_Container_User_Authentication_Token]] object which will be used to authenticate user to login to SoftLayer customer portal. ", + "summary": "Generate a specific type of authentication token", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAuthenticationToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getAuthenticationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Authentication_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getHardwareCount": { + "get": { + "description": "Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the \"administrative\" then \"user admin\" links. ", + "summary": "Retrieve the current number of servers a portal user has access to.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareCount/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getHardwareCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getImpersonationToken": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getImpersonationToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getImpersonationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getOpenIdConnectMigrationState": { + "get": { + "description": "This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown. ", + "summary": "Get the OpenId migration state", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdConnectMigrationState/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getOpenIdConnectMigrationState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPasswordRequirements": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPasswordRequirements/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getPasswordRequirements", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_PasswordSet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginToken": { + "post": { + "description": "Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. ", + "summary": "Authenticate a user for the SoftLayer customer portal", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getPortalLoginToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getPreference": { + "post": { + "description": "Select a type of preference you would like to get using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name. ", + "summary": "Get a preference value for the current user", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreference/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getPreference", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Preference" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getPreferenceTypes": { + "get": { + "description": "Use any of the preference types to fetch or modify user preferences using [[SoftLayer_User_Customer::getPreference|getPreference]] or [[SoftLayer_User_Customer::changePreference|changePreference]], respectively. ", + "summary": "Get all available preference types", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferenceTypes/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getPreferenceTypes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Preference_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getSupportPolicyDocument": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyDocument/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getSupportPolicyDocument", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "base64Binary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getSupportPolicyName": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyName/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getSupportPolicyName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getSupportedLocales": { + "get": { + "description": null, + "summary": "Returns all supported locales for the current user", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportedLocales/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getSupportedLocales", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Locale" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getUserPreferences": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserPreferences/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getUserPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getVirtualGuestCount": { + "get": { + "description": "Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the \"administrative\" then \"user admin\" links. ", + "summary": "Retrieve the current number of CloudLayer Computing Instances a portal user has access to.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuestCount/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getVirtualGuestCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/inTerminalStatus": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inTerminalStatus/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::inTerminalStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/inviteUserToLinkOpenIdConnect": { + "post": { + "description": "Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error. ", + "summary": "Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inviteUserToLinkOpenIdConnect/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::inviteUserToLinkOpenIdConnect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/isMasterUser": { + "get": { + "description": "Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal. ", + "summary": "Determine if a portal user is a master user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isMasterUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::isMasterUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/performExternalAuthentication": { + "post": { + "description": "The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor. ", + "summary": "Perform an external authentication using the given authentication container. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/performExternalAuthentication/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::performExternalAuthentication", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeAllDedicatedHostAccessForThisUser": { + "get": { + "description": "Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. \n\nUsers can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. ", + "summary": "Revoke access to all dedicated hosts on the account for this user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllDedicatedHostAccessForThisUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeAllDedicatedHostAccessForThisUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeAllHardwareAccessForThisUser": { + "get": { + "description": "Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. \n\nUsers can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. ", + "summary": "Remove all hardware from a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllHardwareAccessForThisUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeAllHardwareAccessForThisUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeAllVirtualAccessForThisUser": { + "get": { + "description": "Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. \n\nUsers can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. ", + "summary": "Remove all cloud computing instances from a portal user's instance access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllVirtualAccessForThisUser/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeAllVirtualAccessForThisUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeApiAuthenticationKey": { + "post": { + "description": "Remove a user's API authentication key, removing that user's access to query the SoftLayer API. ", + "summary": "Remove a user's API authentication key.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeApiAuthenticationKey/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeApiAuthenticationKey", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeBulkDedicatedHostAccess": { + "post": { + "description": "Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. \n\nIf the user has full dedicatedHost access, then it will provide access to \"ALL but passed in\" dedicatedHost ids. ", + "summary": "Revoke access for the user for one or more dedicated hosts devices.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeBulkDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeBulkHardwareAccess": { + "post": { + "description": "Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. \n\nIf the user has full hardware access, then it will provide access to \"ALL but passed in\" hardware ids. ", + "summary": "Remove multiple hardware from a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkHardwareAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeBulkHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeBulkPortalPermission": { + "post": { + "description": "Remove (revoke) multiple permissions from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user. \n\nUsers can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account. \n\nIf the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission. \n\nIf the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter. ", + "summary": "Remove multiple permissions from a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkPortalPermission/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeBulkPortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeBulkRoles": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkRoles/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeBulkRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeBulkVirtualGuestAccess": { + "post": { + "description": "Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account. ", + "summary": "Remove multiple CloudLayer Computing Instances from a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeBulkVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeDedicatedHostAccess": { + "post": { + "description": "Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then \"not found\" exceptions are thrown if the user attempts to access any of these devices. \n\nUsers can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. ", + "summary": "Revoke access for the user to a single dedicated hosts device.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeDedicatedHostAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeDedicatedHostAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeExternalBinding": { + "post": { + "description": null, + "summary": "Remove an external binding from this user.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeExternalBinding/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeExternalBinding", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeHardwareAccess": { + "post": { + "description": "Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true. \n\nUsers can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. ", + "summary": "Remove hardware from a portal user's hardware access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeHardwareAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeHardwareAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removePortalPermission": { + "post": { + "description": "Remove (revoke) a permission from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true. \n\nUsers can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. \n\nIf the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission. \n\nIf the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. \n\nUse the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter. ", + "summary": "Remove a permission from a portal user's permission set.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removePortalPermission/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removePortalPermission", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeRole": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeRole/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeRole", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeSecurityAnswers": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeSecurityAnswers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeSecurityAnswers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/removeVirtualGuestAccess": { + "post": { + "description": "Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns \"not found\" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true. \n\nUsers can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account. ", + "summary": "Remove a CloudLayer Computing Instance from a portal user's access list.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeVirtualGuestAccess/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::removeVirtualGuestAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/resetOpenIdConnectLink": { + "post": { + "description": "This method will change the IBMid that a SoftLayer user is linked to, if we need to do that for some reason. It will do this by modifying the link to the desired new IBMid. NOTE: This method cannot be used to \"un-link\" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is already Bluemix linked. To reset a link for the Bluemix-linked user account, use resetOpenIdConnectLinkUnifiedUserManagementMode. ", + "summary": "Change the link of a user for OpenIdConnect managed accounts, provided the", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLink/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::resetOpenIdConnectLink", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/resetOpenIdConnectLinkUnifiedUserManagementMode": { + "post": { + "description": "This method will change the IBMid that a SoftLayer master user is linked to, if we need to do that for some reason. It will do this by unlinking the new owner IBMid from its current user association in this account, if there is one (note that the new owner IBMid is not required to already be a member of the IMS account). Then it will modify the existing IBMid link for the master user to use the new owner IBMid-realm IAMid. At this point, if the new owner IBMid isn't already a member of the PaaS account, it will attempt to add it. As a last step, it will call PaaS to modify the owner on that side, if necessary. Only when all those steps are complete, it will commit the IMS-side DB changes. Then, it will clean up the SoftLayer user that was linked to the new owner IBMid (this user became unlinked as the first step in this process). It will also call BSS to delete the old owner IBMid. NOTE: This method cannot be used to \"un-link\" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is not Bluemix linked. To reset a link for the user account not linked to Bluemix, use resetOpenIdConnectLink. ", + "summary": "Change the link of a master user for OpenIdConnect managed accounts,", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLinkUnifiedUserManagementMode/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::resetOpenIdConnectLinkUnifiedUserManagementMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlAuthenticate": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlAuthenticate/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::samlAuthenticate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginAuthentication": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginAuthentication/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::samlBeginAuthentication", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/samlBeginLogout": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginLogout/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::samlBeginLogout", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/samlLogout": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlLogout/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::samlLogout", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/silentlyMigrateUserOpenIdConnect": { + "post": { + "description": "As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail. ", + "summary": "This api is used to migrate a user to IBMid without sending an invitation.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/silentlyMigrateUserOpenIdConnect/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::silentlyMigrateUserOpenIdConnect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/updateNotificationSubscriber": { + "post": { + "description": "Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription. ", + "summary": "Update the active status for a notification subscription.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateNotificationSubscriber/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::updateNotificationSubscriber", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/updateSecurityAnswers": { + "post": { + "description": "Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers. ", + "summary": "Update portal login security questions and answers.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSecurityAnswers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::updateSecurityAnswers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/updateSubscriberDeliveryMethod": { + "post": { + "description": "Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'. ", + "summary": "Update a delivery method for the subscriber.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSubscriberDeliveryMethod/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::updateSubscriberDeliveryMethod", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/updateVpnPassword": { + "post": { + "description": "Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN passwords must... \n* ...be over eight characters long.\n* ...be under twenty characters long.\n* ...contain at least one uppercase letter\n* ...contain at least one lowercase letter\n* ...contain at least one number\n* ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \\ =\n* ...not match your username\nFinally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords. ", + "summary": "Update a user's VPN password", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnPassword/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::updateVpnPassword", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/validateAuthenticationToken": { + "post": { + "description": "This method validate the given authentication token using the user id by comparing it with the actual user authentication token and return [[SoftLayer_Container_User_Customer_Portal_Token]] object ", + "summary": "Validate the user authentication token", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/validateAuthenticationToken/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::validateAuthenticationToken", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_User_Customer_Portal_Token" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getAccount": { + "get": { + "description": "The customer account that a user belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAccount/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getActions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActions/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getActions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Action" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getAdditionalEmails": { + "get": { + "description": "A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAdditionalEmails/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getAdditionalEmails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_AdditionalEmail" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getApiAuthenticationKeys": { + "get": { + "description": "A portal user's API Authentication keys. There is a max limit of one API key per user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getApiAuthenticationKeys/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getApiAuthenticationKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_ApiAuthentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getChildUsers": { + "get": { + "description": "A portal user's child users. Some portal users may not have child users.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getChildUsers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getChildUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getClosedTickets": { + "get": { + "description": "An user's associated closed tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getClosedTickets/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getClosedTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getDedicatedHosts": { + "get": { + "description": "The dedicated hosts to which the user has been granted access.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDedicatedHosts/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getDedicatedHosts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_DedicatedHost" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getExternalBindings": { + "get": { + "description": "The external authentication bindings that link an external identifier to a SoftLayer user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getExternalBindings/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getExternalBindings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getHardware": { + "get": { + "description": "A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardware/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getHardwareNotifications": { + "get": { + "description": "Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareNotifications/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getHardwareNotifications", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getHasAcknowledgedSupportPolicyFlag": { + "get": { + "description": "Whether or not a user has acknowledged the support policy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasAcknowledgedSupportPolicyFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getHasAcknowledgedSupportPolicyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getHasFullDedicatedHostAccessFlag": { + "get": { + "description": "Permission granting the user access to all Dedicated Host devices on the account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullDedicatedHostAccessFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getHasFullDedicatedHostAccessFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getHasFullHardwareAccessFlag": { + "get": { + "description": "Whether or not a portal user has access to all hardware on their account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullHardwareAccessFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getHasFullHardwareAccessFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getHasFullVirtualGuestAccessFlag": { + "get": { + "description": "Whether or not a portal user has access to all virtual guests on their account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullVirtualGuestAccessFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getHasFullVirtualGuestAccessFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getIbmIdLink": { + "get": { + "description": "Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getIbmIdLink/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getIbmIdLink", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Link" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getLayoutProfiles": { + "get": { + "description": "Contains the definition of the layout profile.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLayoutProfiles/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getLayoutProfiles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Layout_Profile" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getLocale": { + "get": { + "description": "A user's locale. Locale holds user's language and region information.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLocale/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getLocale", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getLoginAttempts": { + "get": { + "description": "A user's attempts to log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAttempts/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getLoginAttempts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Access_Authentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getNotificationSubscribers": { + "get": { + "description": "Notification subscription records for the user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getNotificationSubscribers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getNotificationSubscribers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Subscriber" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getOpenTickets": { + "get": { + "description": "An user's associated open tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenTickets/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getOpenTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getOverrides": { + "get": { + "description": "A portal user's vpn accessible subnets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOverrides/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getOverrides", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Service_Vpn_Overrides" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getParent": { + "get": { + "description": "A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getParent/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getPermissions": { + "get": { + "description": "A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPermissions/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getPermissions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_CustomerPermission_Permission" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getPreferences": { + "get": { + "description": "Data type contains a single user preference to a specific preference type.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferences/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getPreferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Preference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getRoles": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRoles/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Role" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getSecurityAnswers": { + "get": { + "description": "A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSecurityAnswers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getSecurityAnswers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Security_Answer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getSubscribers": { + "get": { + "description": "A user's notification subscription records.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSubscribers/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getSubscribers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_User_Subscriber" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getSuccessfulLogins": { + "get": { + "description": "A user's successful attempts to log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSuccessfulLogins/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getSuccessfulLogins", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Access_Authentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getSupportPolicyAcknowledgementRequiredFlag": { + "get": { + "description": "Whether or not a user is required to acknowledge the support policy for portal access.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyAcknowledgementRequiredFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getSupportPolicyAcknowledgementRequiredFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getSurveyRequiredFlag": { + "get": { + "description": "Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveyRequiredFlag/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getSurveyRequiredFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getSurveys": { + "get": { + "description": "The surveys that a user has taken in the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveys/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getSurveys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Survey" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getTickets": { + "get": { + "description": "An user's associated tickets.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTickets/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getTimezone": { + "get": { + "description": "A portal user's time zone.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTimezone/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getTimezone", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Locale_Timezone" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getUnsuccessfulLogins": { + "get": { + "description": "A user's unsuccessful attempts to log into the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUnsuccessfulLogins/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getUnsuccessfulLogins", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Access_Authentication" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getUserLinks": { + "get": { + "description": "User customer link with IBMid and IAMid.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserLinks/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getUserLinks", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Link" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getUserStatus": { + "get": { + "description": "A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserStatus/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getUserStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/{SoftLayer_User_Customer_OpenIdConnect_TrustedProfileID}/getVirtualGuests": { + "get": { + "description": "A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuests/", + "operationId": "SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getVirtualGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Profile_Event_HyperWarp/receiveEventDirect": { + "post": { + "description": null, + "summary": "Modifies linked Paas user data based on changes initiated by Bluemix.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp/receiveEventDirect/", + "operationId": "SoftLayer_User_Customer_Profile_Event_HyperWarp::receiveEventDirect", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/enroll": { + "post": { + "description": "Create a new Service Provider Enrollment ", + "summary": "Creates a new Service Provider Enrollment", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/enroll/", + "operationId": "SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest::enroll", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/{SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequestID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getObject/", + "operationId": "SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/{SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequestID}/getCompanyType": { + "get": { + "description": "Catalyst company types.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getCompanyType/", + "operationId": "SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest::getCompanyType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Catalyst_Company_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Security_Answer/{SoftLayer_User_Customer_Security_AnswerID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_User_Customer_Security_Answer object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Security_Answer service. ", + "summary": "Retrieve a SoftLayer_User_Customer_Security_Answer record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Security_Answer/getObject/", + "operationId": "SoftLayer_User_Customer_Security_Answer::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Security_Answer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Security_Answer/{SoftLayer_User_Customer_Security_AnswerID}/getQuestion": { + "get": { + "description": "The question the security answer is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Security_Answer/getQuestion/", + "operationId": "SoftLayer_User_Customer_Security_Answer::getQuestion", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Security_Question" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Security_Answer/{SoftLayer_User_Customer_Security_AnswerID}/getUser": { + "get": { + "description": "The user who the security answer belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Security_Answer/getUser/", + "operationId": "SoftLayer_User_Customer_Security_Answer::getUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Status/getAllObjects": { + "get": { + "description": "Retrieve all user status objects.", + "summary": "Retrieve all user status objects.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Status/getAllObjects/", + "operationId": "SoftLayer_User_Customer_Status::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Status" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Customer_Status/{SoftLayer_User_Customer_StatusID}/getObject": { + "get": { + "description": "getObject retrieves the SoftLayer_User_Customer_Status object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Status service. ", + "summary": "Retrieve a SoftLayer_User_Customer_Status record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Customer_Status/getObject/", + "operationId": "SoftLayer_User_Customer_Status::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_External_Binding/{SoftLayer_User_External_BindingID}/deleteObject": { + "get": { + "description": "Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form. ", + "summary": "Delete an external authentication binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_External_Binding/deleteObject/", + "operationId": "SoftLayer_User_External_Binding::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_External_Binding/{SoftLayer_User_External_BindingID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_External_Binding record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_External_Binding/getObject/", + "operationId": "SoftLayer_User_External_Binding::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_External_Binding/{SoftLayer_User_External_BindingID}/updateNote": { + "post": { + "description": "Update the note of an external binding. The note is an optional property that is used to store information about a binding. ", + "summary": "Update the note of an external binding.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_External_Binding/updateNote/", + "operationId": "SoftLayer_User_External_Binding::updateNote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_External_Binding/{SoftLayer_User_External_BindingID}/getAttributes": { + "get": { + "description": "Attributes of an external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_External_Binding/getAttributes/", + "operationId": "SoftLayer_User_External_Binding::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_External_Binding/{SoftLayer_User_External_BindingID}/getBillingItem": { + "get": { + "description": "Information regarding the billing item for external authentication.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_External_Binding/getBillingItem/", + "operationId": "SoftLayer_User_External_Binding::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_External_Binding/{SoftLayer_User_External_BindingID}/getNote": { + "get": { + "description": "An optional note for identifying the external binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_External_Binding/getNote/", + "operationId": "SoftLayer_User_External_Binding::getNote", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_External_Binding/{SoftLayer_User_External_BindingID}/getType": { + "get": { + "description": "The type of external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_External_Binding/getType/", + "operationId": "SoftLayer_User_External_Binding::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_External_Binding/{SoftLayer_User_External_BindingID}/getVendor": { + "get": { + "description": "The vendor of an external authentication binding.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_External_Binding/getVendor/", + "operationId": "SoftLayer_User_External_Binding::getVendor", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Vendor" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_External_Binding_Vendor/getAllObjects": { + "get": { + "description": "getAllObjects() will return a list of the available external binding vendors that SoftLayer supports. Use this list to select the appropriate vendor when creating a new external binding. ", + "summary": "Get a list of all available external binding vendors that SoftLayer supports.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_External_Binding_Vendor/getAllObjects/", + "operationId": "SoftLayer_User_External_Binding_Vendor::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Vendor" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_External_Binding_Vendor/{SoftLayer_User_External_Binding_VendorID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_External_Binding_Vendor record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_External_Binding_Vendor/getObject/", + "operationId": "SoftLayer_User_External_Binding_Vendor::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_External_Binding_Vendor" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Action/getAllObjects": { + "get": { + "description": "Object filters and result limits are enabled on this method. ", + "summary": "Retrieve all customer permission actions in IMS.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Action/getAllObjects/", + "operationId": "SoftLayer_User_Permission_Action::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Action" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Action/{SoftLayer_User_Permission_ActionID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Permission_Action record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Action/getObject/", + "operationId": "SoftLayer_User_Permission_Action::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Action" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Action/{SoftLayer_User_Permission_ActionID}/getDepartment": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Action/getDepartment/", + "operationId": "SoftLayer_User_Permission_Action::getDepartment", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Department" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Department/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Department/getAllObjects/", + "operationId": "SoftLayer_User_Permission_Department::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Department" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Department/{SoftLayer_User_Permission_DepartmentID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Permission_Department record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Department/getObject/", + "operationId": "SoftLayer_User_Permission_Department::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Department" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Department/{SoftLayer_User_Permission_DepartmentID}/getPermissions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Department/getPermissions/", + "operationId": "SoftLayer_User_Permission_Department::getPermissions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Action" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/addAction": { + "post": { + "description": "Assigns a SoftLayer_User_Permission_Action object to the group. ", + "summary": "Add a permission action to the group.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/addAction/", + "operationId": "SoftLayer_User_Permission_Group::addAction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/addBulkActions": { + "post": { + "description": "Assigns multiple SoftLayer_User_Permission_Action objects to the group. ", + "summary": "Adds a list of permission actions to the group.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/addBulkActions/", + "operationId": "SoftLayer_User_Permission_Group::addBulkActions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/addBulkResourceObjects": { + "post": { + "description": "Links multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects to the group. All objects must be of the same type. ", + "summary": "Links multiple account device objects of the same resource type to the group.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/addBulkResourceObjects/", + "operationId": "SoftLayer_User_Permission_Group::addBulkResourceObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/addResourceObject": { + "post": { + "description": "Links a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object to the group. ", + "summary": "Links a hardware, virtual guest, or dedicated host object on the", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/addResourceObject/", + "operationId": "SoftLayer_User_Permission_Group::addResourceObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/createObject": { + "post": { + "description": "Customer created permission groups must be of type NORMAL. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users. ", + "summary": "Create a new customer permission group", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/createObject/", + "operationId": "SoftLayer_User_Permission_Group::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/deleteObject": { + "get": { + "description": "Customer users can only delete permission groups of type NORMAL. The SYSTEM type is reserved for internal use. The user who is creating the permission group must have the permission to manage users. ", + "summary": "Delete a new customer permission group", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/deleteObject/", + "operationId": "SoftLayer_User_Permission_Group::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/editObject": { + "post": { + "description": "Allows a user to modify the name and description of an existing customer permission group. Customer permission groups must be of type NORMAL. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users. ", + "summary": "Edit an existing customer permission group", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/editObject/", + "operationId": "SoftLayer_User_Permission_Group::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Permission_Group record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/getObject/", + "operationId": "SoftLayer_User_Permission_Group::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/linkRole": { + "post": { + "description": "Links a SoftLayer_User_Permission_Role object to the group. ", + "summary": "Links a permission role to the group.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/linkRole/", + "operationId": "SoftLayer_User_Permission_Group::linkRole", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/removeAction": { + "post": { + "description": "Unassigns a SoftLayer_User_Permission_Action object from the group. ", + "summary": "Remove a permission action from the group.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/removeAction/", + "operationId": "SoftLayer_User_Permission_Group::removeAction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/removeBulkActions": { + "post": { + "description": "Unassigns multiple SoftLayer_User_Permission_Action objects from the group. ", + "summary": "Remove a list of permission actions from the group.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/removeBulkActions/", + "operationId": "SoftLayer_User_Permission_Group::removeBulkActions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/removeBulkResourceObjects": { + "post": { + "description": "Unlinks multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects from the group. All objects must be of the same type. ", + "summary": "Unlinks multiple account device objects of the same resource type from the group.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/removeBulkResourceObjects/", + "operationId": "SoftLayer_User_Permission_Group::removeBulkResourceObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/removeResourceObject": { + "post": { + "description": "Unlinks a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object from the group. ", + "summary": "Unlinks a hardware, virtual guest, or dedicated host object on the", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/removeResourceObject/", + "operationId": "SoftLayer_User_Permission_Group::removeResourceObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/unlinkRole": { + "post": { + "description": "Removes a link from SoftLayer_User_Permission_Role object to the group. ", + "summary": "Unlinks a permission role from the group.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/unlinkRole/", + "operationId": "SoftLayer_User_Permission_Group::unlinkRole", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/getAccount/", + "operationId": "SoftLayer_User_Permission_Group::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/getActions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/getActions/", + "operationId": "SoftLayer_User_Permission_Group::getActions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Action" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/getRoles": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/getRoles/", + "operationId": "SoftLayer_User_Permission_Group::getRoles", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Role" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group/{SoftLayer_User_Permission_GroupID}/getType": { + "get": { + "description": "The type of the permission group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group/getType/", + "operationId": "SoftLayer_User_Permission_Group::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Group_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group_Type/{SoftLayer_User_Permission_Group_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Permission_Group_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group_Type/getObject/", + "operationId": "SoftLayer_User_Permission_Group_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Group_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Group_Type/{SoftLayer_User_Permission_Group_TypeID}/getGroups": { + "get": { + "description": "The groups that are of this type.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Group_Type/getGroups/", + "operationId": "SoftLayer_User_Permission_Group_Type::getGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Resource_Type/getAllObjects": { + "get": { + "description": "Retrieve an array of SoftLayer_User_Permission_Resource_Type objects. ", + "summary": "Retrieve an array of SoftLayer_User_Permission_Resource_Type objects. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Resource_Type/getAllObjects/", + "operationId": "SoftLayer_User_Permission_Resource_Type::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Resource_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Resource_Type/{SoftLayer_User_Permission_Resource_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Permission_Resource_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Resource_Type/getObject/", + "operationId": "SoftLayer_User_Permission_Resource_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Resource_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/addUser": { + "post": { + "description": "Assigns a SoftLayer_User_Customer object to the role. ", + "summary": "Assign a user customer to the role.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/addUser/", + "operationId": "SoftLayer_User_Permission_Role::addUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/createObject": { + "post": { + "description": "Customer created permission roles must set the systemFlag attribute to false. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users. ", + "summary": "Create a new customer permission role", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/createObject/", + "operationId": "SoftLayer_User_Permission_Role::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Role" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/deleteObject": { + "get": { + "description": "Customer users can only delete permission roles with systemFlag set to false. The SYSTEM type is reserved for internal use. The user who is creating the permission role must have the permission to manage users. ", + "summary": "Delete a new customer permission role", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/deleteObject/", + "operationId": "SoftLayer_User_Permission_Role::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/editObject": { + "post": { + "description": "Allows a user to modify the name and description of an existing customer permission role. Customer permission roles must set the systemFlag attribute to false. The SYSTEM type is reserved for internal use. The account id supplied in the template permission role must match account id of the user who is creating the permission role. The user who is creating the permission role must have the permission to manage users. ", + "summary": "Edit an existing customer permission role", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/editObject/", + "operationId": "SoftLayer_User_Permission_Role::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Role" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_User_Permission_Role record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/getObject/", + "operationId": "SoftLayer_User_Permission_Role::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Role" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/linkGroup": { + "post": { + "description": "Links a SoftLayer_User_Permission_Group object to the role. ", + "summary": "Links a permission group to the role.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/linkGroup/", + "operationId": "SoftLayer_User_Permission_Role::linkGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/removeUser": { + "post": { + "description": "Unassigns a SoftLayer_User_Customer object from the role. ", + "summary": "Unassign a user customer from the role.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/removeUser/", + "operationId": "SoftLayer_User_Permission_Role::removeUser", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/unlinkGroup": { + "post": { + "description": "Unlinks a SoftLayer_User_Permission_Group object to the role. ", + "summary": "Unlinks a permission group to the role.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/unlinkGroup/", + "operationId": "SoftLayer_User_Permission_Role::unlinkGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/getAccount": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/getAccount/", + "operationId": "SoftLayer_User_Permission_Role::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/getActions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/getActions/", + "operationId": "SoftLayer_User_Permission_Role::getActions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Action" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/getGroups": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/getGroups/", + "operationId": "SoftLayer_User_Permission_Role::getGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Permission_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Permission_Role/{SoftLayer_User_Permission_RoleID}/getUsers": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Permission_Role/getUsers/", + "operationId": "SoftLayer_User_Permission_Role::getUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Security_Question/getAllObjects": { + "get": { + "description": "Retrieve all viewable security questions.", + "summary": "Retrieve all viewable security questions.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Security_Question/getAllObjects/", + "operationId": "SoftLayer_User_Security_Question::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Security_Question" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_User_Security_Question/{SoftLayer_User_Security_QuestionID}/getObject": { + "get": { + "description": "getAllObjects retrieves all the SoftLayer_User_Security_Question objects where it is set to be viewable. ", + "summary": "Retrieve a SoftLayer_User_Security_Question record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_User_Security_Question/getObject/", + "operationId": "SoftLayer_User_Security_Question::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_User_Security_Question" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Utility_Network/nsLookup": { + "post": { + "description": "A method used to return the nameserver information for a given address", + "summary": "Perform a nameserver lookup on given address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Utility_Network/nsLookup/", + "operationId": "SoftLayer_Utility_Network::nsLookup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Utility_Network/whois": { + "post": { + "description": "Perform a WHOIS lookup from SoftLayer's application servers on the given IP address or hostname and return the raw results of that command. The returned result is similar to the result received from running the command `whois` from a UNIX command shell. A WHOIS lookup queries a host's registrar to retrieve domain registrant information including registration date, expiry date, and the administrative, technical, billing, and abuse contacts responsible for a domain. WHOIS lookups are useful for determining a physical contact responsible for a particular domain. WHOIS lookups are also useful for determining domain availability. Running a WHOIS lookup on an IP address queries ARIN for that IP block's ownership, and is helpful for determining a physical entity responsible for a certain IP address. ", + "summary": "Perform a WHOIS lookup on a given address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Utility_Network/whois/", + "operationId": "SoftLayer_Utility_Network::whois", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Verify_Api_HttpObj/createObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Verify_Api_HttpObj/createObject/", + "operationId": "SoftLayer_Verify_Api_HttpObj::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Verify_Api_HttpObj" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Verify_Api_HttpObj/{SoftLayer_Verify_Api_HttpObjID}/deleteObject": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Verify_Api_HttpObj/deleteObject/", + "operationId": "SoftLayer_Verify_Api_HttpObj::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Verify_Api_HttpObj/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Verify_Api_HttpObj/getAllObjects/", + "operationId": "SoftLayer_Verify_Api_HttpObj::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Verify_Api_HttpObj" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Verify_Api_HttpObj/{SoftLayer_Verify_Api_HttpObjID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Verify_Api_HttpObj record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Verify_Api_HttpObj/getObject/", + "operationId": "SoftLayer_Verify_Api_HttpObj::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Verify_Api_HttpObj" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Verify_Api_HttpsObj/createObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Verify_Api_HttpsObj/createObject/", + "operationId": "SoftLayer_Verify_Api_HttpsObj::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Verify_Api_HttpsObj" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Verify_Api_HttpsObj/{SoftLayer_Verify_Api_HttpsObjID}/deleteObject": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Verify_Api_HttpsObj/deleteObject/", + "operationId": "SoftLayer_Verify_Api_HttpsObj::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Verify_Api_HttpsObj/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Verify_Api_HttpsObj/getAllObjects/", + "operationId": "SoftLayer_Verify_Api_HttpsObj::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Verify_Api_HttpsObj" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Verify_Api_HttpsObj/{SoftLayer_Verify_Api_HttpsObjID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Verify_Api_HttpsObj record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Verify_Api_HttpsObj/getObject/", + "operationId": "SoftLayer_Verify_Api_HttpsObj::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Verify_Api_HttpsObj" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/deleteObject": { + "get": { + "description": "This method will cancel a dedicated host immediately. ", + "summary": "Reclaim a dedicated host to cancel it's use. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/deleteObject/", + "operationId": "SoftLayer_Virtual_DedicatedHost::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/editObject": { + "post": { + "description": "Edit a dedicated host's properties. ", + "summary": "Edit a dedicated host's properties. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/editObject/", + "operationId": "SoftLayer_Virtual_DedicatedHost::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/getAvailableRouters": { + "post": { + "description": "This method will get the available backend routers to order a dedicated host. ", + "summary": "Get available backend routers in a datacenter to order a dedicated host. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getAvailableRouters/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getAvailableRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_DedicatedHost record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getObject/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_DedicatedHost" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/setTags": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/setTags/", + "operationId": "SoftLayer_Virtual_DedicatedHost::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getAccount": { + "get": { + "description": "The account that the dedicated host belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getAccount/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getAllocationStatus": { + "get": { + "description": "The container that represents allocations on the dedicated host.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getAllocationStatus/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getAllocationStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Virtual_DedicatedHost_AllocationStatus" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getBackendRouter": { + "get": { + "description": "The backend router behind dedicated host's pool of resources.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getBackendRouter/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getBackendRouter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Router_Backend" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getBillingItem": { + "get": { + "description": "The billing item for the dedicated host.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getBillingItem/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Virtual_DedicatedHost" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getDatacenter": { + "get": { + "description": "The datacenter that the dedicated host resides in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getDatacenter/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getGuests": { + "get": { + "description": "The guests associated with the dedicated host.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getGuests/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getInternalTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getInternalTagReferences/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getInternalTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getPciDeviceAllocationStatus": { + "get": { + "description": "The container that represents PCI device allocations on the dedicated host.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDeviceAllocationStatus/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getPciDeviceAllocationStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getPciDevices": { + "get": { + "description": "A collection of SoftLayer_Virtual_Host_PciDevice objects on the host.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDevices/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getPciDevices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host_PciDevice" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_DedicatedHost/{SoftLayer_Virtual_DedicatedHostID}/getTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_DedicatedHost/getTagReferences/", + "operationId": "SoftLayer_Virtual_DedicatedHost::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/editObject": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/editObject/", + "operationId": "SoftLayer_Virtual_Disk_Image::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/getAvailableBootModes": { + "get": { + "description": "Returns a collection of boot modes that are supported for primary disks. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getAvailableBootModes/", + "operationId": "SoftLayer_Virtual_Disk_Image::getAvailableBootModes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_Disk_Image record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getObject/", + "operationId": "SoftLayer_Virtual_Disk_Image::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/getPublicIsoImages": { + "get": { + "description": "Retrieves images from the public ISO repository ", + "summary": "Retrieves images from the public ISO repository.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getPublicIsoImages/", + "operationId": "SoftLayer_Virtual_Disk_Image::getPublicIsoImages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getBillingItem": { + "get": { + "description": "The billing item for a virtual disk image.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getBillingItem/", + "operationId": "SoftLayer_Virtual_Disk_Image::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Virtual_Disk_Image" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getBlockDevices": { + "get": { + "description": "The block devices that a disk image is attached to. Block devices connect computing instances to disk images.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getBlockDevices/", + "operationId": "SoftLayer_Virtual_Disk_Image::getBlockDevices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getBootableVolumeFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getBootableVolumeFlag/", + "operationId": "SoftLayer_Virtual_Disk_Image::getBootableVolumeFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getCloudInitFlag": { + "get": { + "description": "Check if cloud-init is enabled.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getCloudInitFlag/", + "operationId": "SoftLayer_Virtual_Disk_Image::getCloudInitFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getCoalescedDiskImages": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getCoalescedDiskImages/", + "operationId": "SoftLayer_Virtual_Disk_Image::getCoalescedDiskImages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getCopyOnWriteFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getCopyOnWriteFlag/", + "operationId": "SoftLayer_Virtual_Disk_Image::getCopyOnWriteFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getDiskFileExtension": { + "get": { + "description": "Return disk file extension", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getDiskFileExtension/", + "operationId": "SoftLayer_Virtual_Disk_Image::getDiskFileExtension", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getDiskImageStorageGroup": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getDiskImageStorageGroup/", + "operationId": "SoftLayer_Virtual_Disk_Image::getDiskImageStorageGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getImportedDiskType": { + "get": { + "description": "Return imported disk type", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getImportedDiskType/", + "operationId": "SoftLayer_Virtual_Disk_Image::getImportedDiskType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getIsEncrypted": { + "get": { + "description": "Return if image is encrypted", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getIsEncrypted/", + "operationId": "SoftLayer_Virtual_Disk_Image::getIsEncrypted", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getLocalDiskFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getLocalDiskFlag/", + "operationId": "SoftLayer_Virtual_Disk_Image::getLocalDiskFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getMetadataFlag": { + "get": { + "description": "Whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getMetadataFlag/", + "operationId": "SoftLayer_Virtual_Disk_Image::getMetadataFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getSoftwareReferences": { + "get": { + "description": "References to the software that resides on a disk image.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getSoftwareReferences/", + "operationId": "SoftLayer_Virtual_Disk_Image::getSoftwareReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image_Software" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getSourceDiskImage": { + "get": { + "description": "The original disk image that the current disk image was cloned from.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getSourceDiskImage/", + "operationId": "SoftLayer_Virtual_Disk_Image::getSourceDiskImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getStorageGroupDetails": { + "get": { + "description": "Return storage group details for symantec disk", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroupDetails/", + "operationId": "SoftLayer_Virtual_Disk_Image::getStorageGroupDetails", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Image_StorageGroupDetails" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getStorageGroups": { + "get": { + "description": "The storage group for a virtual disk image.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroups/", + "operationId": "SoftLayer_Virtual_Disk_Image::getStorageGroups", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Configuration_Storage_Group" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getStorageRepository": { + "get": { + "description": "The storage repository that a disk image resides in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepository/", + "operationId": "SoftLayer_Virtual_Disk_Image::getStorageRepository", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Storage_Repository" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getStorageRepositoryType": { + "get": { + "description": "The type of storage repository that a disk image resides in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepositoryType/", + "operationId": "SoftLayer_Virtual_Disk_Image::getStorageRepositoryType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Storage_Repository_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getSupportedHardware": { + "get": { + "description": "Return supported hardware component IDs for symantec disk", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getSupportedHardware/", + "operationId": "SoftLayer_Virtual_Disk_Image::getSupportedHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getTemplateBlockDevice": { + "get": { + "description": "The template that attaches a disk image to a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|archive]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getTemplateBlockDevice/", + "operationId": "SoftLayer_Virtual_Disk_Image::getTemplateBlockDevice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Disk_Image/{SoftLayer_Virtual_Disk_ImageID}/getType": { + "get": { + "description": "A virtual disk image's type.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Disk_Image/getType/", + "operationId": "SoftLayer_Virtual_Disk_Image::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/activatePrivatePort": { + "get": { + "description": "Activate the private network port", + "summary": "Activate the private port", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/activatePrivatePort/", + "operationId": "SoftLayer_Virtual_Guest::activatePrivatePort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/activatePublicPort": { + "get": { + "description": "Activate the public network port", + "summary": "Activate the public port", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/activatePublicPort/", + "operationId": "SoftLayer_Virtual_Guest::activatePublicPort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/allowAccessToNetworkStorage": { + "post": { + "description": "This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control. ", + "summary": "Allow access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorage/", + "operationId": "SoftLayer_Virtual_Guest::allowAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/allowAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Allow access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorageList/", + "operationId": "SoftLayer_Virtual_Guest::allowAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/attachDiskImage": { + "post": { + "description": "Creates a transaction to attach a guest's disk image. If the disk image is already attached it will be ignored. \n\nWARNING: SoftLayer_Virtual_Guest::checkHostDiskAvailability should be called before this method. If the SoftLayer_Virtual_Guest::checkHostDiskAvailability method is not called before this method, the guest migration will happen automatically. ", + "summary": "Attaches a disk image.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/attachDiskImage/", + "operationId": "SoftLayer_Virtual_Guest::attachDiskImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/cancelIsolationForDestructiveAction": { + "get": { + "description": "Reopens the public and/or private ports to reverse the changes made when the server was isolated for a destructive action. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/cancelIsolationForDestructiveAction/", + "operationId": "SoftLayer_Virtual_Guest::cancelIsolationForDestructiveAction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/captureImage": { + "post": { + "description": "Captures a Flex Image of the hard disk on the virtual machine, based on the capture template parameter. Returns the image template group containing the disk image. ", + "summary": "Captures a Flex Image of the hard disk on the virtual machine.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/captureImage/", + "operationId": "SoftLayer_Virtual_Guest::captureImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/checkHostDiskAvailability": { + "post": { + "description": "Checks the associated host for available disk space to determine if guest migration is necessary. This method is only used with local disks. If this method returns false, calling attachDiskImage($imageId) will automatically migrate the destination guest to a new host before attaching the portable volume. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/checkHostDiskAvailability/", + "operationId": "SoftLayer_Virtual_Guest::checkHostDiskAvailability", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/configureMetadataDisk": { + "get": { + "description": "Creates a transaction to configure the guest's metadata disk. If the guest has user data associated with it, the transaction will create a small virtual drive and write the metadata to a file on the drive; if the drive already exists, the metadata will be rewritten. If the guest has no user data associated with it, the transaction will remove the virtual drive if it exists. \n\nWARNING: The transaction created by this service will shut down the guest while the metadata disk is configured. The guest will be turned back on once this process is complete. ", + "summary": "Configures the guest's metadata disk.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/configureMetadataDisk/", + "operationId": "SoftLayer_Virtual_Guest::configureMetadataDisk", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/createArchiveTemplate": { + "post": { + "description": "Create a transaction to archive a computing instance's block devices", + "summary": "[[SoftLayer_Virtual_Guest_Block_Devices|Block Devices]] can be grouped together in and backed up in an archive for later use. This method generates a transaction to perform an archive of the provided block devices. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/createArchiveTemplate/", + "operationId": "SoftLayer_Virtual_Guest::createArchiveTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/createArchiveTransaction": { + "post": { + "description": "Create a transaction to archive a computing instance's block devices", + "summary": "[[SoftLayer_Virtual_Guest_Block_Device]] can be grouped together in and backed up in an archive for later use. This method generates a transaction to perform an archive of the provided block devices. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/createArchiveTransaction/", + "operationId": "SoftLayer_Virtual_Guest::createArchiveTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/createObject": { + "post": { + "description": "\ncreateObject() enables the creation of computing instances on an account. This method is a simplified alternative to interacting with the ordering system directly. \n\n\nIn order to create a computing instance, a template object must be sent in with a few required values. \n\n\nWhen this method returns an order will have been placed for a computing instance of the specified configuration. \n\n\nTo determine when the instance is available you can poll the instance via [[SoftLayer_Virtual_Guest/getObject]], with an object mask requesting the `provisionDate` relational property. When `provisionDate` is not `null`, the instance will be ready. \n\n\n> **Warning:** Computing instances created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Virtual_Guest/generateOrderTemplate]]. \n\n\n### Required Input [[SoftLayer_Virtual_Guest]]\n\n\n\n- `Hostname` String **Required** \n + Hostname for the computing instance. \n- `Domain` String **Required** \n + Domain for the computing instance. \n- `startCpus` Integer **Required** \n + The number of CPU cores to allocate. \n + See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options. \n- `maxMemory` Integer **Required** \n + The amount of memory to allocate in megabytes. \n + See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options. \n- `datacenter.name` *String* **Required** \n + Specifies which datacenter the instance is to be provisioned in. Needs to be a nested object. \n + Example: `\"datacenter\": {\"name\": \"dal05\"}` \n + See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options. \n\n\n- `hourlyBillingFlag` Boolean **Required** \n + Specifies the billing type for the instance. \n + True for hourly billing, False for monthly billing. \n- `localDiskFlag` Boolean **Required** \n + Specifies the disk type for the instance. \n + True for local to the instance disks, False for SAN disks. \n- `dedicatedAccountHostOnlyFlag` Boolean \n + When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account. \n + Default: False \n- `operatingSystemReferenceCode` String **Conditionally required** \n + An identifier for the operating system to provision the computing instance with. \n + Not required when using a `blockDeviceTemplateGroup.globalIdentifier`, as the template will have its own operating system. \n + See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options. \n + **Notice**: Some operating systems are billed based on the number of CPUs the guest has. The price which is used can be determined by calling \n [[SoftLayer_Virtual_Guest/generateOrderTemplate]] with your desired device specifications. \n- `blockDeviceTemplateGroup.globalIdentifier` String \n + The GUID for the template to be used to provision the computing instance. \n + Conflicts with `operatingSystemReferenceCode` \n + **Notice**: Some operating systems are billed based on the number of CPUs the guest has. The price which is used can be determined by calling \n [[SoftLayer_Virtual_Guest/generateOrderTemplate]] with your desired device specifications. \n + A list of public images may be obtained via a request to [[SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages]] \n + A list of private images may be obtained via a request to [[SoftLayer_Account/getPrivateBlockDeviceTemplateGroups]] \n + Example: `\"blockDeviceTemplateGroup\": { globalIdentifier\": \"07beadaa-1e11-476e-a188-3f7795feb9fb\"` \n- `networkComponents.maxSpeed` Integer \n + Specifies the connection speed for the instance's network components. \n + The `networkComponents` property is an array with a single [[SoftLayer_Virtual_Guest_Network_Component]] structure. \n The `maxSpeed` property must be set to specify the network uplink speed, in megabits per second, of the computing instance. \n + See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options. \n + Default: 10 \n + Example: `\"networkComponents\": [{\"maxSpeed\": 1000}]` \n- `privateNetworkOnlyFlag` Boolean \n + When true this flag specifies that a compute instance is to only have access to the private network. \n + Default: False \n- `primaryNetworkComponent.networkVlan.id` Integer \n + Specifies the network vlan which is to be used for the frontend interface of the computing instance. \n + The `primaryNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `networkVlan` property populated with a i \n [[SoftLayer_Network_Vlan]] structure. The `id` property must be set to specify the frontend network vlan of the computing instance. \n + *NOTE* This is the VLAN `id`, NOT the vlan number. \n + Example: `\"primaryNetworkComponent\":{\"networkVlan\": {\"id\": 1234567}}` \n- `backendNetworkComponent.networkVlan.id` Integer \n + Specifies the network vlan which is to be used for the backend interface of the computing instance. \n + The `backendNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `networkVlan` property populated with a \n [[SoftLayer_Network_Vlan]] structure. The `id` property must be set to specify the backend network vlan of the computing instance. \n + *NOTE* This is the VLAN `id`, NOT the vlan number. \n + Example: `\"backendNetworkComponent\":{\"networkVlan\": {\"id\": 1234567}}` \n- `primaryNetworkComponent.securityGroupBindings` [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]][] \n + Specifies the security groups to be attached to this VSI's frontend network adapter \n + The `primaryNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `securityGroupBindings` property populated \n with an array of [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]] structures. The `securityGroup` property in each must be set to \n specify the security group to be attached to the primary frontend network component. \n + Example: \n ``` \n \"primaryNetworkComponent\": { \n \"securityGroupBindings\": [ \n {\"securityGroup\":{\"id\": 5555555}}, \n {\"securityGroup\":{\"id\": 1112223}}, \n ] \n } \n ``` \n- `primaryBackendNetworkComponent.securityGroupBindings` [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]][] \n + Specifies the security groups to be attached to this VSI's backend network adapter \n + The `primaryNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `securityGroupBindings` property populated \n with an array of [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]] structures. The `securityGroup` property in each must be set to \n specify the security group to be attached to the primary frontend network component. \n + Example: \n ``` \n \"primaryBackendNetworkComponent\": { \n \"securityGroupBindings\": [ \n {\"securityGroup\":{\"id\": 33322211}}, \n {\"securityGroup\":{\"id\": 77777222}}, \n ] \n } \n ``` \n- `blockDevices` [[SoftLayer_Virtual_Guest_Block_Device]][] \n + Block device and disk image settings for the computing instance \n + The `blockDevices` property is an array of [[SoftLayer_Virtual_Guest_Block_Device]] structures. Each block device must specify the `device` property \n along with the `diskImage` property, which is a [[SoftLayer_Virtual_Disk_Image]] structure with the `capacity` property set. The `device` number `'1'` \n is reserved for the SWAP disk attached to the computing instance. \n + Default: The smallest available capacity for the primary disk will be used. If an image template is specified the disk capacity will be be provided by the template. \n + Example: \n ``` \n \"blockDevices\":[{\"device\": \"0\", \"diskImage\": {\"capacity\": 100}}], \n \"localDiskFlag\": true \n ``` \n + See [[SoftLayer_Virtual_Guest/getCreateObjectOptions]] for available options. \n- `userData.value` String \n + Arbitrary data to be made available to the computing instance. \n + The `userData` property is an array with a single [[SoftLayer_Virtual_Guest_Attribute]] structure with the `value` property set to an arbitrary value. \n This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata]] method from a request originating from the computing instance. \n This is primarily useful for providing data to software that may be on the instance and configured to execute upon first boot. \n + Example: `\"userData\":[{\"value\": \"testData\"}]` \n- `sshKeys` [[SoftLayer_Security_Ssh_Key]][] \n + The `sshKeys` property is an array of [[SoftLayer_Security_Ssh_Key]] structures with the `id` property set to the value of an existing SSH key. \n + To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]]. \n + To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys]] \n + Example: `\"sshKeys\":[{\"id\": 1234567}]` \n- `postInstallScriptUri` String \n + Specifies the uri location of the script to be downloaded and run after installation is complete. Only scripts from HTTPS servers are executed on startup. \n\n\nREST Example: \n``` \ncurl -X POST -d '{ \n \"parameters\":[ \n { \n \"hostname\": \"host1\", \n \"domain\": \"example.com\", \n \"startCpus\": 1, \n \"maxMemory\": 1024, \n \"hourlyBillingFlag\": true, \n \"localDiskFlag\": true, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\" \n } \n}' https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/createObject.json \n\n\nHTTP/1.1 201 Created \nLocation: https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/1301396/getObject \n\n\n{ \n \"accountId\": 232298, \n \"createDate\": \"2012-11-30T16:28:17-06:00\", \n \"dedicatedAccountHostOnlyFlag\": false, \n \"domain\": \"example.com\", \n \"hostname\": \"host1\", \n \"id\": 1301396, \n \"lastPowerStateId\": null, \n \"lastVerifiedDate\": null, \n \"maxCpu\": 1, \n \"maxCpuUnits\": \"CORE\", \n \"maxMemory\": 1024, \n \"metricPollDate\": null, \n \"modifyDate\": null, \n \"privateNetworkOnlyFlag\": false, \n \"startCpus\": 1, \n \"statusId\": 1001, \n \"globalIdentifier\": \"2d203774-0ee1-49f5-9599-6ef67358dd31\" \n} \n``` ", + "summary": "Create a new computing instance", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/createObject/", + "operationId": "SoftLayer_Virtual_Guest::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/createObjects": { + "post": { + "description": "\ncreateObjects() enables the creation of multiple computing instances on an account in a single call. This \nmethod is a simplified alternative to interacting with the ordering system directly. \n\n\nIn order to create a computing instance a set of template objects must be sent in with a few required \nvalues. \n\n\nWarning: Computing instances created via this method will incur charges on your account. \n\n\nSee [[SoftLayer_Virtual_Guest/createObject|createObject]] for specifics on the requirements of each template object. \n\n\n

Example

\ncurl -X POST -d '{ \n \"parameters\":[ \n [ \n { \n \"hostname\": \"host1\", \n \"domain\": \"example.com\", \n \"startCpus\": 1, \n \"maxMemory\": 1024, \n \"hourlyBillingFlag\": true, \n \"localDiskFlag\": true, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\" \n }, \n { \n \"hostname\": \"host2\", \n \"domain\": \"example.com\", \n \"startCpus\": 1, \n \"maxMemory\": 1024, \n \"hourlyBillingFlag\": true, \n \"localDiskFlag\": true, \n \"operatingSystemReferenceCode\": \"UBUNTU_LATEST\" \n } \n ] \n ] \n}' https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Guest/createObjects.json \n \nHTTP/1.1 200 OK \n\n\n[ \n { \n \"accountId\": 232298, \n \"createDate\": \"2012-11-30T23:56:48-06:00\", \n \"dedicatedAccountHostOnlyFlag\": false, \n \"domain\": \"softlayer.com\", \n \"hostname\": \"ubuntu1\", \n \"id\": 1301456, \n \"lastPowerStateId\": null, \n \"lastVerifiedDate\": null, \n \"maxCpu\": 1, \n \"maxCpuUnits\": \"CORE\", \n \"maxMemory\": 1024, \n \"metricPollDate\": null, \n \"modifyDate\": null, \n \"privateNetworkOnlyFlag\": false, \n \"startCpus\": 1, \n \"statusId\": 1001, \n \"globalIdentifier\": \"fed4c822-48c0-45d0-85e2-90476aa0c542\" \n }, \n { \n \"accountId\": 232298, \n \"createDate\": \"2012-11-30T23:56:49-06:00\", \n \"dedicatedAccountHostOnlyFlag\": false, \n \"domain\": \"softlayer.com\", \n \"hostname\": \"ubuntu2\", \n \"id\": 1301457, \n \"lastPowerStateId\": null, \n \"lastVerifiedDate\": null, \n \"maxCpu\": 1, \n \"maxCpuUnits\": \"CORE\", \n \"maxMemory\": 1024, \n \"metricPollDate\": null, \n \"modifyDate\": null, \n \"privateNetworkOnlyFlag\": false, \n \"startCpus\": 1, \n \"statusId\": 1001, \n \"globalIdentifier\": \"bed4c686-9562-4ade-9049-dc4d5b6b200c\" \n } \n] \n ", + "summary": "Create new computing instances", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/createObjects/", + "operationId": "SoftLayer_Virtual_Guest::createObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/createPostSoftwareInstallTransaction": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/createPostSoftwareInstallTransaction/", + "operationId": "SoftLayer_Virtual_Guest::createPostSoftwareInstallTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/deleteObject": { + "get": { + "description": "\nThis method will cancel a computing instance effective immediately. For instances billed hourly, the charges will stop immediately after the method returns. ", + "summary": "Delete a computing instance", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/deleteObject/", + "operationId": "SoftLayer_Virtual_Guest::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/deleteTag": { + "post": { + "description": null, + "summary": "Delete a tag", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/deleteTag/", + "operationId": "SoftLayer_Virtual_Guest::deleteTag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/deleteTransientWebhook": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/deleteTransientWebhook/", + "operationId": "SoftLayer_Virtual_Guest::deleteTransientWebhook", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/detachDiskImage": { + "post": { + "description": "Creates a transaction to detach a guest's disk image. If the disk image is already detached it will be ignored. \n\nWARNING: The transaction created by this service will shut down the guest while the disk image is attached. The guest will be turned back on once this process is complete. ", + "summary": "Detaches a disk image.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/detachDiskImage/", + "operationId": "SoftLayer_Virtual_Guest::detachDiskImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/editObject": { + "post": { + "description": "Edit a computing instance's properties ", + "summary": "Edit a computing instance's properties", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/editObject/", + "operationId": "SoftLayer_Virtual_Guest::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/executeIderaBareMetalRestore": { + "get": { + "description": "Reboot a guest into the Idera Bare Metal Restore image. ", + "summary": "Reboot a guest into the Idera Bare Metal Restore image.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/executeIderaBareMetalRestore/", + "operationId": "SoftLayer_Virtual_Guest::executeIderaBareMetalRestore", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/executeR1SoftBareMetalRestore": { + "get": { + "description": "Reboot a guest into the R1Soft Bare Metal Restore image. ", + "summary": "Reboot a guest into the R1Soft Bare Metal Restore image.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/executeR1SoftBareMetalRestore/", + "operationId": "SoftLayer_Virtual_Guest::executeR1SoftBareMetalRestore", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/executeRemoteScript": { + "post": { + "description": "Download and run remote script from uri on virtual guests.", + "summary": "Download and run remote script from uri on the virtual guest. Requires https for script to be executed after download. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/executeRemoteScript/", + "operationId": "SoftLayer_Virtual_Guest::executeRemoteScript", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/executeRescueLayer": { + "get": { + "description": "Reboot a Linux guest into the Xen rescue image. ", + "summary": "Reboot a Linux guest into the Xen rescue image.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/executeRescueLayer/", + "operationId": "SoftLayer_Virtual_Guest::executeRescueLayer", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/findByHostname": { + "post": { + "description": "Find VSIs by hostname. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/findByHostname/", + "operationId": "SoftLayer_Virtual_Guest::findByHostname", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/findByIpAddress": { + "post": { + "description": "Find CCI by only its primary public or private IP address. IP addresses within secondary subnets tied to the CCI will not return the CCI. If no CCI is found, no errors are generated and no data is returned. ", + "summary": "Find CCI by its primary public or private IP (ipv4) address.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/findByIpAddress/", + "operationId": "SoftLayer_Virtual_Guest::findByIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/generateOrderTemplate": { + "post": { + "description": "\nObtain an [[SoftLayer_Container_Product_Order_Virtual_Guest (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]]. \n\n\nThis is primarily useful when there is a necessity to confirm the price which will be charged for an order. \n\n\nSee [[SoftLayer_Virtual_Guest/createObject|createObject]] for specifics on the requirements of the template object parameter. ", + "summary": "Obtain an order container for a given template object", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/generateOrderTemplate/", + "operationId": "SoftLayer_Virtual_Guest::generateOrderTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAdditionalRequiredPricesForOsReload": { + "post": { + "description": "Return a collection of SoftLayer_Item_Price objects for an OS reload", + "summary": "Return a collection of SoftLayer_Item_Price objects for an OS reload", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAdditionalRequiredPricesForOsReload/", + "operationId": "SoftLayer_Virtual_Guest::getAdditionalRequiredPricesForOsReload", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAttachedNetworkStorages": { + "post": { + "description": "This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Virtual_Guest. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAttachedNetworkStorages/", + "operationId": "SoftLayer_Virtual_Guest::getAttachedNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAvailableBlockDevicePositions": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAvailableBlockDevicePositions/", + "operationId": "SoftLayer_Virtual_Guest::getAvailableBlockDevicePositions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAvailableNetworkStorages": { + "post": { + "description": "This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Virtual_Guest. ", + "summary": "Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAvailableNetworkStorages/", + "operationId": "SoftLayer_Virtual_Guest::getAvailableNetworkStorages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBandwidthDataByDate": { + "post": { + "description": "Use this method when needing the metric data for bandwidth for a single guest. It will gather the correct input parameters based on the date ranges ", + "summary": "Retrieve the amount of network traffic that occurred for the specified time frame for a computing instance. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBandwidthDataByDate/", + "operationId": "SoftLayer_Virtual_Guest::getBandwidthDataByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/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": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBandwidthForDateRange/", + "operationId": "SoftLayer_Virtual_Guest::getBandwidthForDateRange", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBandwidthImage": { + "post": { + "description": "Use this method when needing a bandwidth image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. ", + "summary": "Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBandwidthImage/", + "operationId": "SoftLayer_Virtual_Guest::getBandwidthImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBandwidthImageByDate": { + "post": { + "description": "Use this method when needing a bandwidth image for a single guest. It will gather the correct input parameters for the generic graphing utility based on the date ranges ", + "summary": "Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBandwidthImageByDate/", + "operationId": "SoftLayer_Virtual_Guest::getBandwidthImageByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBandwidthTotal": { + "post": { + "description": "Returns the total amount of bandwidth used during the time specified for a computing instance. ", + "summary": "Retrieve total amount of network traffic that was in use during the time specified by the input parameters for a computing instance. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBandwidthTotal/", + "operationId": "SoftLayer_Virtual_Guest::getBandwidthTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedLong" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBootMode": { + "get": { + "description": "Retrieves the boot mode of the VSI. ", + "summary": "Retrieves the boot mode of the VSI.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBootMode/", + "operationId": "SoftLayer_Virtual_Guest::getBootMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBootOrder": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBootOrder/", + "operationId": "SoftLayer_Virtual_Guest::getBootOrder", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getConsoleAccessLog": { + "get": { + "description": "Gets the console access logs for a computing instance ", + "summary": "get console access logs", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getConsoleAccessLog/", + "operationId": "SoftLayer_Virtual_Guest::getConsoleAccessLog", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Logging_Syslog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getCoreRestrictedOperatingSystemPrice": { + "get": { + "description": "If the virtual server currently has an operating system that has a core capacity restriction, return the associated core-restricted operating system item price. Some operating systems (e.g., Red Hat Enterprise Linux) may be billed by the number of processor cores, so therefore require that a certain number of cores be present on the server. ", + "summary": "Return the associated core-restricted operating system item price for the virtual server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getCoreRestrictedOperatingSystemPrice/", + "operationId": "SoftLayer_Virtual_Guest::getCoreRestrictedOperatingSystemPrice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getCpuMetricDataByDate": { + "post": { + "description": "Use this method when needing the metric data for a single guest's CPUs. It will gather the correct input parameters based on the date ranges ", + "summary": "Retrieve records containing the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getCpuMetricDataByDate/", + "operationId": "SoftLayer_Virtual_Guest::getCpuMetricDataByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getCpuMetricImage": { + "post": { + "description": "Use this method when needing a cpu usage image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. ", + "summary": "Retrieve a visual representation of the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImage/", + "operationId": "SoftLayer_Virtual_Guest::getCpuMetricImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getCpuMetricImageByDate": { + "post": { + "description": "Use this method when needing a CPU usage image for a single guest. It will gather the correct input parameters for the generic graphing utility based on the date ranges ", + "summary": "Retrieve a visual representation of the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImageByDate/", + "operationId": "SoftLayer_Virtual_Guest::getCpuMetricImageByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/getCreateObjectOptions": { + "get": { + "description": "\nThere are many options that may be provided while ordering a computing instance, this method can be used to determine what these options are. \n\n\nDetailed information on the return value can be found on the data type page for [[SoftLayer_Container_Virtual_Guest_Configuration (type)]]. ", + "summary": "Determine options available when creating a computing instance", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions/", + "operationId": "SoftLayer_Virtual_Guest::getCreateObjectOptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Virtual_Guest_Configuration" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getCurrentBillingDetail": { + "get": { + "description": "Get the billing detail for this instance for the current billing period. This does not include bandwidth usage. ", + "summary": "<< EOT", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingDetail/", + "operationId": "SoftLayer_Virtual_Guest::getCurrentBillingDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getCurrentBillingTotal": { + "get": { + "description": "Get the total bill amount in US Dollars ($) for this instance in the current billing period. This includes all bandwidth used up to the point this method is called on the instance. ", + "summary": "Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingTotal/", + "operationId": "SoftLayer_Virtual_Guest::getCurrentBillingTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getDriveRetentionItemPrice": { + "get": { + "description": "Return a drive retention SoftLayer_Item_Price object for a guest.", + "summary": "Return a drive retention SoftLayer_Item_Price object for a guest.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getDriveRetentionItemPrice/", + "operationId": "SoftLayer_Virtual_Guest::getDriveRetentionItemPrice", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getFirewallProtectableSubnets": { + "get": { + "description": "Get the subnets associated with this CloudLayer computing instance that are protectable by a network component firewall. ", + "summary": "Get the subnets associated with this CloudLayer computing instance that are protectable by a network component firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getFirewallProtectableSubnets/", + "operationId": "SoftLayer_Virtual_Guest::getFirewallProtectableSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getFirstAvailableBlockDevicePosition": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getFirstAvailableBlockDevicePosition/", + "operationId": "SoftLayer_Virtual_Guest::getFirstAvailableBlockDevicePosition", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getIsoBootImage": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getIsoBootImage/", + "operationId": "SoftLayer_Virtual_Guest::getIsoBootImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getItemPricesFromSoftwareDescriptions": { + "post": { + "description": "Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description", + "summary": "Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getItemPricesFromSoftwareDescriptions/", + "operationId": "SoftLayer_Virtual_Guest::getItemPricesFromSoftwareDescriptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMemoryMetricDataByDate": { + "post": { + "description": "Use this method when needing the metric data for memory for a single computing instance. ", + "summary": "Retrieve records containing the amount memory that was used for the specified time frame for a computing instance. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricDataByDate/", + "operationId": "SoftLayer_Virtual_Guest::getMemoryMetricDataByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMemoryMetricImage": { + "post": { + "description": "Use this method when needing a memory usage image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. ", + "summary": "Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImage/", + "operationId": "SoftLayer_Virtual_Guest::getMemoryMetricImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMemoryMetricImageByDate": { + "post": { + "description": "Use this method when needing a image displaying the amount of memory used over time for a single computing instance. It will gather the correct input parameters for the generic graphing utility based on the date ranges ", + "summary": "Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImageByDate/", + "operationId": "SoftLayer_Virtual_Guest::getMemoryMetricImageByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getNetworkComponentFirewallProtectableIpAddresses": { + "get": { + "description": "Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this CloudLayer computing instance. Please use getFirewallProtectableSubnets to get all protectable subnets. ", + "summary": "Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getNetworkComponentFirewallProtectableIpAddresses/", + "operationId": "SoftLayer_Virtual_Guest::getNetworkComponentFirewallProtectableIpAddresses", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_Guest record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getObject/", + "operationId": "SoftLayer_Virtual_Guest::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getOrderTemplate": { + "post": { + "description": "Obtain an order container that is ready to be sent to the [[SoftLayer_Product_Order#placeOrder|SoftLayer_Product_Order::placeOrder]] method. This container will include all services that the selected computing instance has. If desired you may remove prices which were returned. ", + "summary": "Obtain an order container that is ready to be sent to the [[SoftLayer_Product_Order#placeOrder|SoftLayer_Product_Order::placeOrder]] method.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getOrderTemplate/", + "operationId": "SoftLayer_Virtual_Guest::getOrderTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Product_Order" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getPendingMaintenanceActions": { + "get": { + "description": "Returns a list of all the pending maintenance actions affecting this guest. ", + "summary": "Returns a list of all the pending maintenance actions affecting this guest. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getPendingMaintenanceActions/", + "operationId": "SoftLayer_Virtual_Guest::getPendingMaintenanceActions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Container_Virtual_Guest_PendingMaintenanceAction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getProvisionDate": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getProvisionDate/", + "operationId": "SoftLayer_Virtual_Guest::getProvisionDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "dateTime" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getRecentMetricData": { + "post": { + "description": "Recent metric data for a guest ", + "summary": "Recent metric data for a guest ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getRecentMetricData/", + "operationId": "SoftLayer_Virtual_Guest::getRecentMetricData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getReverseDomainRecords": { + "get": { + "description": "Retrieve the reverse domain records associated with this server. ", + "summary": "Retrieve the reverse domain records associated with a server.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getReverseDomainRecords/", + "operationId": "SoftLayer_Virtual_Guest::getReverseDomainRecords", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Dns_Domain" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getUpgradeItemPrices": { + "post": { + "description": "Retrieves a list of all upgrades available to a virtual server. Upgradeable items include, but are not limited to, number of cores, amount of RAM, storage configuration, and network port speed. \n\nThis method exclude downgrade item prices by default. You can set the \"includeDowngradeItemPrices\" parameter to true so that it can include downgrade item prices. ", + "summary": "Retrieve a computing instance's upgradeable items.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getUpgradeItemPrices/", + "operationId": "SoftLayer_Virtual_Guest::getUpgradeItemPrices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Product_Item_Price" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getValidBlockDeviceTemplateGroups": { + "post": { + "description": "This method will return the list of block device template groups that are valid to the host. For instance, it will validate that the template groups returned are compatible with the size and number of disks on the host. ", + "summary": "Return a list of valid block device template groups based on this host", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getValidBlockDeviceTemplateGroups/", + "operationId": "SoftLayer_Virtual_Guest::getValidBlockDeviceTemplateGroups", + "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_Virtual_Guest/{SoftLayer_Virtual_GuestID}/isBackendPingable": { + "get": { + "description": "Issues a ping command and returns the success (true) or failure (false) of the ping command. ", + "summary": "Verifies if a guest's backend ip address is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/isBackendPingable/", + "operationId": "SoftLayer_Virtual_Guest::isBackendPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/isCloudInit": { + "get": { + "description": "Determines if the virtual guest was provisioned from a cloud-init enabled image. ", + "summary": "Determines if the virtual guest was provisioned from a cloud-init enabled image. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/isCloudInit/", + "operationId": "SoftLayer_Virtual_Guest::isCloudInit", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/isPingable": { + "get": { + "description": "Issues a ping command and returns the success (true) or failure (false) of the ping command. ", + "summary": "Verifies if guest is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/isPingable/", + "operationId": "SoftLayer_Virtual_Guest::isPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/isolateInstanceForDestructiveAction": { + "get": { + "description": "Closes the public or private ports to isolate the instance before a destructive action. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/isolateInstanceForDestructiveAction/", + "operationId": "SoftLayer_Virtual_Guest::isolateInstanceForDestructiveAction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/migrate": { + "get": { + "description": "Creates a transaction to migrate a virtual guest to a new host. NOTE: Will only migrate if SoftLayer_Virtual_Guest property pendingMigrationFlag = true", + "summary": "Creates a transaction to migrate a virtual guest to a new host. NOTE: Will only migrate if SoftLayer_Virtual_Guest property pendingMigrationFlag = true ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/migrate/", + "operationId": "SoftLayer_Virtual_Guest::migrate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/migrateDedicatedHost": { + "post": { + "description": "Create a transaction to migrate an instance from one dedicated host to another dedicated host ", + "summary": "Migrate a dedicated instance from one dedicated host to another dedicated host ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/migrateDedicatedHost/", + "operationId": "SoftLayer_Virtual_Guest::migrateDedicatedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/mountIsoImage": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/mountIsoImage/", + "operationId": "SoftLayer_Virtual_Guest::mountIsoImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/pause": { + "get": { + "description": "Pause a virtual guest. This can only be called when the specified VM is in the Running state. ", + "summary": "Pause a guest.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/pause/", + "operationId": "SoftLayer_Virtual_Guest::pause", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/powerCycle": { + "get": { + "description": "Power cycle a virtual guest ", + "summary": "Power cycle a guest.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/powerCycle/", + "operationId": "SoftLayer_Virtual_Guest::powerCycle", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/powerOff": { + "get": { + "description": "Power off a virtual guest ", + "summary": "Power off a guest.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/powerOff/", + "operationId": "SoftLayer_Virtual_Guest::powerOff", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/powerOffSoft": { + "get": { + "description": "Power off a virtual guest ", + "summary": "Cleanly shut down a guest and disable power", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/powerOffSoft/", + "operationId": "SoftLayer_Virtual_Guest::powerOffSoft", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/powerOn": { + "get": { + "description": "Power on a virtual guest ", + "summary": "Power on a guest.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/powerOn/", + "operationId": "SoftLayer_Virtual_Guest::powerOn", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/rebootDefault": { + "get": { + "description": "Power cycle a virtual guest ", + "summary": "Power cycle a guest.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/rebootDefault/", + "operationId": "SoftLayer_Virtual_Guest::rebootDefault", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/rebootHard": { + "get": { + "description": "Power cycle a guest. ", + "summary": "Power cycle a guest.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/rebootHard/", + "operationId": "SoftLayer_Virtual_Guest::rebootHard", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/rebootSoft": { + "get": { + "description": "Attempt to complete a soft reboot of a guest by shutting down the operating system. ", + "summary": "Attempt to complete a soft reboot of a guest by shutting down the operating system.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/rebootSoft/", + "operationId": "SoftLayer_Virtual_Guest::rebootSoft", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/reconfigureConsole": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/reconfigureConsole/", + "operationId": "SoftLayer_Virtual_Guest::reconfigureConsole", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/reloadCurrentOperatingSystemConfiguration": { + "get": { + "description": "Create a transaction to perform an OS reload ", + "summary": "Perform an OS reload", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/reloadCurrentOperatingSystemConfiguration/", + "operationId": "SoftLayer_Virtual_Guest::reloadCurrentOperatingSystemConfiguration", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/reloadOperatingSystem": { + "post": { + "description": "Reloads current operating system configuration. \n\nThis service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server. \n\nAs a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the computing instance to the current specifications on record. \n\nIf reloading from an image template, we recommend first getting the list of valid private block device template groups, by calling the getOperatingSystemReloadImages method. ", + "summary": "Reloads operating system configuration.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/reloadOperatingSystem/", + "operationId": "SoftLayer_Virtual_Guest::reloadOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/removeAccessToNetworkStorage": { + "post": { + "description": "This method is used to remove access to a SoftLayer_Network_Storage volume that supports host- or network-level access control. ", + "summary": "Remove access to a SoftLayer_Network_Storage volume from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorage/", + "operationId": "SoftLayer_Virtual_Guest::removeAccessToNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/removeAccessToNetworkStorageList": { + "post": { + "description": "This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. ", + "summary": "Remove access to multiple SoftLayer_Network_Storage volumes from this device. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorageList/", + "operationId": "SoftLayer_Virtual_Guest::removeAccessToNetworkStorageList", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/removeTags": { + "post": { + "description": null, + "summary": "Remove a tag reference", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/removeTags/", + "operationId": "SoftLayer_Virtual_Guest::removeTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/resume": { + "get": { + "description": "Resume a virtual guest, this can only be called when a VSI is in Suspended state. ", + "summary": "Resume a guest.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/resume/", + "operationId": "SoftLayer_Virtual_Guest::resume", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/sendTestReclaimScheduledAlert": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/sendTestReclaimScheduledAlert/", + "operationId": "SoftLayer_Virtual_Guest::sendTestReclaimScheduledAlert", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/setPrivateNetworkInterfaceSpeed": { + "post": { + "description": "Sets the private network interface speed to the new speed. Speed values can only be 0 (Disconnect), 10, 100, or 1000. The new speed must be equal to or less than the max speed of the interface. \n\nIt will take less than a minute to update the port speed. ", + "summary": "Updates the private network interface (eth0) speed.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/setPrivateNetworkInterfaceSpeed/", + "operationId": "SoftLayer_Virtual_Guest::setPrivateNetworkInterfaceSpeed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/setPublicNetworkInterfaceSpeed": { + "post": { + "description": "Sets the public network interface speed to the new speed. Speed values can only be 0 (Disconnect), 10, 100, or 1000. The new speed must be equal to or less than the max speed of the interface. \n\nIt will take less than a minute to update the port speed. ", + "summary": "Updates the public network interface (eth1) speed.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/setPublicNetworkInterfaceSpeed/", + "operationId": "SoftLayer_Virtual_Guest::setPublicNetworkInterfaceSpeed", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/setTags": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/setTags/", + "operationId": "SoftLayer_Virtual_Guest::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/setTransientWebhook": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/setTransientWebhook/", + "operationId": "SoftLayer_Virtual_Guest::setTransientWebhook", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "void" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/setUserMetadata": { + "post": { + "description": "Sets the data that will be written to the configuration drive. ", + "summary": "Configures the guest's metadata disk.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/setUserMetadata/", + "operationId": "SoftLayer_Virtual_Guest::setUserMetadata", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/shutdownPrivatePort": { + "get": { + "description": "Shuts down the private network port", + "summary": "Shuts down the private port", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/shutdownPrivatePort/", + "operationId": "SoftLayer_Virtual_Guest::shutdownPrivatePort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/shutdownPublicPort": { + "get": { + "description": "Shuts down the public network port", + "summary": "Shuts down the public port", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/shutdownPublicPort/", + "operationId": "SoftLayer_Virtual_Guest::shutdownPublicPort", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/unmountIsoImage": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/unmountIsoImage/", + "operationId": "SoftLayer_Virtual_Guest::unmountIsoImage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/validateImageTemplate": { + "post": { + "description": "Validate an image template for OS Reload ", + "summary": "Validates an image template for OS Reload", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/validateImageTemplate/", + "operationId": "SoftLayer_Virtual_Guest::validateImageTemplate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/verifyReloadOperatingSystem": { + "post": { + "description": "Verify that a virtual server can go through the operating system reload process. It may be useful to call this method before attempting to actually reload the operating system just to verify that the reload will go smoothly. If the server configuration is not setup correctly or there is some other issue, an exception will be thrown indicating the error. If there were no issues, this will just return true. ", + "summary": "Verify that a virtual server can go through the operating system reload process.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/verifyReloadOperatingSystem/", + "operationId": "SoftLayer_Virtual_Guest::verifyReloadOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAccount": { + "get": { + "description": "The account that a virtual guest belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAccount/", + "operationId": "SoftLayer_Virtual_Guest::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAccountOwnedPoolFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAccountOwnedPoolFlag/", + "operationId": "SoftLayer_Virtual_Guest::getAccountOwnedPoolFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getActiveNetworkMonitorIncident": { + "get": { + "description": "A virtual guest's currently active network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getActiveNetworkMonitorIncident/", + "operationId": "SoftLayer_Virtual_Guest::getActiveNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getActiveTickets": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getActiveTickets/", + "operationId": "SoftLayer_Virtual_Guest::getActiveTickets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getActiveTransaction": { + "get": { + "description": "A transaction that is still be performed on a cloud server.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getActiveTransaction/", + "operationId": "SoftLayer_Virtual_Guest::getActiveTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getActiveTransactions": { + "get": { + "description": "Any active transaction(s) that are currently running for the server (example: os reload).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getActiveTransactions/", + "operationId": "SoftLayer_Virtual_Guest::getActiveTransactions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAllowedHost": { + "get": { + "description": "The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAllowedHost/", + "operationId": "SoftLayer_Virtual_Guest::getAllowedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage_Allowed_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAllowedNetworkStorage": { + "get": { + "description": "The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorage/", + "operationId": "SoftLayer_Virtual_Guest::getAllowedNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAllowedNetworkStorageReplicas": { + "get": { + "description": "The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorageReplicas/", + "operationId": "SoftLayer_Virtual_Guest::getAllowedNetworkStorageReplicas", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAntivirusSpywareSoftwareComponent": { + "get": { + "description": "A antivirus / spyware software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAntivirusSpywareSoftwareComponent/", + "operationId": "SoftLayer_Virtual_Guest::getAntivirusSpywareSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getApplicationDeliveryController": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getApplicationDeliveryController/", + "operationId": "SoftLayer_Virtual_Guest::getApplicationDeliveryController", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Application_Delivery_Controller" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAttributes": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAttributes/", + "operationId": "SoftLayer_Virtual_Guest::getAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAvailableMonitoring": { + "get": { + "description": "An object that stores the maximum level for the monitoring query types and response types.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAvailableMonitoring/", + "operationId": "SoftLayer_Virtual_Guest::getAvailableMonitoring", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAverageDailyPrivateBandwidthUsage": { + "get": { + "description": "The average daily private bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPrivateBandwidthUsage/", + "operationId": "SoftLayer_Virtual_Guest::getAverageDailyPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getAverageDailyPublicBandwidthUsage": { + "get": { + "description": "The average daily public bandwidth usage for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPublicBandwidthUsage/", + "operationId": "SoftLayer_Virtual_Guest::getAverageDailyPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBackendNetworkComponents": { + "get": { + "description": "A guests's backend network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBackendNetworkComponents/", + "operationId": "SoftLayer_Virtual_Guest::getBackendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBackendRouters": { + "get": { + "description": "A guest's backend or private router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBackendRouters/", + "operationId": "SoftLayer_Virtual_Guest::getBackendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBandwidthAllocation": { + "get": { + "description": "A computing instance's allotted bandwidth (measured in GB).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllocation/", + "operationId": "SoftLayer_Virtual_Guest::getBandwidthAllocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBandwidthAllotmentDetail": { + "get": { + "description": "A computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllotmentDetail/", + "operationId": "SoftLayer_Virtual_Guest::getBandwidthAllotmentDetail", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBillingCycleBandwidthUsage": { + "get": { + "description": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBillingCycleBandwidthUsage/", + "operationId": "SoftLayer_Virtual_Guest::getBillingCycleBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBillingCyclePrivateBandwidthUsage": { + "get": { + "description": "The raw private bandwidth usage data for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePrivateBandwidthUsage/", + "operationId": "SoftLayer_Virtual_Guest::getBillingCyclePrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBillingCyclePublicBandwidthUsage": { + "get": { + "description": "The raw public bandwidth usage data for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePublicBandwidthUsage/", + "operationId": "SoftLayer_Virtual_Guest::getBillingCyclePublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Usage" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBillingItem": { + "get": { + "description": "The billing item for a CloudLayer Compute Instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBillingItem/", + "operationId": "SoftLayer_Virtual_Guest::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBlockCancelBecauseDisconnectedFlag": { + "get": { + "description": "Determines whether the instance is ineligible for cancellation because it is disconnected.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBlockCancelBecauseDisconnectedFlag/", + "operationId": "SoftLayer_Virtual_Guest::getBlockCancelBecauseDisconnectedFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBlockDeviceTemplateGroup": { + "get": { + "description": "The global identifier for the image template that was used to provision or reload a guest.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBlockDeviceTemplateGroup/", + "operationId": "SoftLayer_Virtual_Guest::getBlockDeviceTemplateGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBlockDevices": { + "get": { + "description": "A computing instance's block devices. Block devices link [[SoftLayer_Virtual_Disk_Image|disk images]] to computing instances.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBlockDevices/", + "operationId": "SoftLayer_Virtual_Guest::getBlockDevices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBrowserConsoleAccessLogs": { + "get": { + "description": "A virtual guest's browser access logs.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getBrowserConsoleAccessLogs/", + "operationId": "SoftLayer_Virtual_Guest::getBrowserConsoleAccessLogs", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_BrowserConsoleAccessLog" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getConsoleData": { + "get": { + "description": "A container for a guest's console data", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getConsoleData/", + "operationId": "SoftLayer_Virtual_Guest::getConsoleData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Virtual_ConsoleData" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getConsoleIpAddressFlag": { + "get": { + "description": "[DEPRECATED] A flag indicating a computing instance's console IP address is assigned.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressFlag/", + "operationId": "SoftLayer_Virtual_Guest::getConsoleIpAddressFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getConsoleIpAddressRecord": { + "get": { + "description": "[DEPRECATED] A record containing information about a computing instance's console IP and port number.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressRecord/", + "operationId": "SoftLayer_Virtual_Guest::getConsoleIpAddressRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getContinuousDataProtectionSoftwareComponent": { + "get": { + "description": "A continuous data protection software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getContinuousDataProtectionSoftwareComponent/", + "operationId": "SoftLayer_Virtual_Guest::getContinuousDataProtectionSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getControlPanel": { + "get": { + "description": "A guest's control panel.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getControlPanel/", + "operationId": "SoftLayer_Virtual_Guest::getControlPanel", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getCurrentBandwidthSummary": { + "get": { + "description": "An object that provides commonly used bandwidth summary components for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getCurrentBandwidthSummary/", + "operationId": "SoftLayer_Virtual_Guest::getCurrentBandwidthSummary", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getDatacenter": { + "get": { + "description": "The datacenter that a virtual guest resides in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getDatacenter/", + "operationId": "SoftLayer_Virtual_Guest::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getDedicatedHost": { + "get": { + "description": "The dedicated host associated with this guest.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getDedicatedHost/", + "operationId": "SoftLayer_Virtual_Guest::getDedicatedHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_DedicatedHost" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getDeviceStatus": { + "get": { + "description": "The device status of this virtual guest.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getDeviceStatus/", + "operationId": "SoftLayer_Virtual_Guest::getDeviceStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Device_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getEvaultNetworkStorage": { + "get": { + "description": "A guest's associated EVault network storage service account.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getEvaultNetworkStorage/", + "operationId": "SoftLayer_Virtual_Guest::getEvaultNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getFirewallServiceComponent": { + "get": { + "description": "A computing instance's hardware firewall services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getFirewallServiceComponent/", + "operationId": "SoftLayer_Virtual_Guest::getFirewallServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getFrontendNetworkComponents": { + "get": { + "description": "A guest's frontend network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getFrontendNetworkComponents/", + "operationId": "SoftLayer_Virtual_Guest::getFrontendNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getFrontendRouters": { + "get": { + "description": "A guest's frontend or public router.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getFrontendRouters/", + "operationId": "SoftLayer_Virtual_Guest::getFrontendRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getGlobalIdentifier": { + "get": { + "description": "A guest's universally unique identifier.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getGlobalIdentifier/", + "operationId": "SoftLayer_Virtual_Guest::getGlobalIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getGpuCount": { + "get": { + "description": "The number of GPUs attached to the guest.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getGpuCount/", + "operationId": "SoftLayer_Virtual_Guest::getGpuCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getGpuType": { + "get": { + "description": "The name of the GPU type attached to the guest.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getGpuType/", + "operationId": "SoftLayer_Virtual_Guest::getGpuType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getGuestBootParameter": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getGuestBootParameter/", + "operationId": "SoftLayer_Virtual_Guest::getGuestBootParameter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Boot_Parameter" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getHardwareFunctionDescription": { + "get": { + "description": "The object's function.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getHardwareFunctionDescription/", + "operationId": "SoftLayer_Virtual_Guest::getHardwareFunctionDescription", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getHost": { + "get": { + "description": "The virtual host on which a virtual guest resides (available only on private clouds).", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getHost/", + "operationId": "SoftLayer_Virtual_Guest::getHost", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getHostIpsSoftwareComponent": { + "get": { + "description": "A host IPS software component object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getHostIpsSoftwareComponent/", + "operationId": "SoftLayer_Virtual_Guest::getHostIpsSoftwareComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getHourlyBillingFlag": { + "get": { + "description": "A guest's hourly billing status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getHourlyBillingFlag/", + "operationId": "SoftLayer_Virtual_Guest::getHourlyBillingFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getInboundPrivateBandwidthUsage": { + "get": { + "description": "The total private inbound bandwidth for this computing instance for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getInboundPrivateBandwidthUsage/", + "operationId": "SoftLayer_Virtual_Guest::getInboundPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getInboundPublicBandwidthUsage": { + "get": { + "description": "The total public inbound bandwidth for this computing instance for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getInboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Virtual_Guest::getInboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getInternalTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getInternalTagReferences/", + "operationId": "SoftLayer_Virtual_Guest::getInternalTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getLastKnownPowerState": { + "get": { + "description": "The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getLastKnownPowerState/", + "operationId": "SoftLayer_Virtual_Guest::getLastKnownPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Power_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getLastOperatingSystemReload": { + "get": { + "description": "The last transaction that a cloud server's operating system was loaded.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getLastOperatingSystemReload/", + "operationId": "SoftLayer_Virtual_Guest::getLastOperatingSystemReload", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getLastTransaction": { + "get": { + "description": "The last transaction a cloud server had performed.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getLastTransaction/", + "operationId": "SoftLayer_Virtual_Guest::getLastTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getLatestNetworkMonitorIncident": { + "get": { + "description": "A virtual guest's latest network monitoring incident.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getLatestNetworkMonitorIncident/", + "operationId": "SoftLayer_Virtual_Guest::getLatestNetworkMonitorIncident", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getLocalDiskFlag": { + "get": { + "description": "A flag indicating that the virtual guest has at least one disk which is local to the host it runs on. This does not include a SWAP device.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getLocalDiskFlag/", + "operationId": "SoftLayer_Virtual_Guest::getLocalDiskFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getLocation": { + "get": { + "description": "Where guest is located within SoftLayer's location hierarchy.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getLocation/", + "operationId": "SoftLayer_Virtual_Guest::getLocation", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getManagedResourceFlag": { + "get": { + "description": "A flag indicating that the virtual guest is a managed resource.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getManagedResourceFlag/", + "operationId": "SoftLayer_Virtual_Guest::getManagedResourceFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMetricTrackingObject": { + "get": { + "description": "A guest's metric tracking object.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObject/", + "operationId": "SoftLayer_Virtual_Guest::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMetricTrackingObjectId": { + "get": { + "description": "The metric tracking object id for this guest.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObjectId/", + "operationId": "SoftLayer_Virtual_Guest::getMetricTrackingObjectId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMonitoringRobot": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getMonitoringRobot/", + "operationId": "SoftLayer_Virtual_Guest::getMonitoringRobot", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Monitoring_Robot" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMonitoringServiceComponent": { + "get": { + "description": "A virtual guest's network monitoring services.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceComponent/", + "operationId": "SoftLayer_Virtual_Guest::getMonitoringServiceComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMonitoringServiceEligibilityFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceEligibilityFlag/", + "operationId": "SoftLayer_Virtual_Guest::getMonitoringServiceEligibilityFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMonitoringUserNotification": { + "get": { + "description": "The monitoring notification objects for this guest. Each object links this guest instance to a user account that will be notified if monitoring on this guest object fails", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getMonitoringUserNotification/", + "operationId": "SoftLayer_Virtual_Guest::getMonitoringUserNotification", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer_Notification_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getNetworkComponents": { + "get": { + "description": "A guests's network components.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getNetworkComponents/", + "operationId": "SoftLayer_Virtual_Guest::getNetworkComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getNetworkMonitorIncidents": { + "get": { + "description": "All of a virtual guest's network monitoring incidents.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitorIncidents/", + "operationId": "SoftLayer_Virtual_Guest::getNetworkMonitorIncidents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Incident" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getNetworkMonitors": { + "get": { + "description": "A guests's network monitors.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitors/", + "operationId": "SoftLayer_Virtual_Guest::getNetworkMonitors", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Monitor_Version1_Query_Host" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getNetworkStorage": { + "get": { + "description": "A guest's associated network storage accounts.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getNetworkStorage/", + "operationId": "SoftLayer_Virtual_Guest::getNetworkStorage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Storage" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getNetworkVlans": { + "get": { + "description": "The network Vlans that a guest's network components are associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getNetworkVlans/", + "operationId": "SoftLayer_Virtual_Guest::getNetworkVlans", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getOpenCancellationTicket": { + "get": { + "description": "An open ticket requesting cancellation of this server, if one exists.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getOpenCancellationTicket/", + "operationId": "SoftLayer_Virtual_Guest::getOpenCancellationTicket", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Ticket" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getOperatingSystem": { + "get": { + "description": "A guest's operating system.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getOperatingSystem/", + "operationId": "SoftLayer_Virtual_Guest::getOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Software_Component_OperatingSystem" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getOperatingSystemReferenceCode": { + "get": { + "description": "A guest's operating system software description.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getOperatingSystemReferenceCode/", + "operationId": "SoftLayer_Virtual_Guest::getOperatingSystemReferenceCode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getOrderedPackageId": { + "get": { + "description": "The original package id provided with the order for a Cloud Computing Instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getOrderedPackageId/", + "operationId": "SoftLayer_Virtual_Guest::getOrderedPackageId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getOutboundPrivateBandwidthUsage": { + "get": { + "description": "The total private outbound bandwidth for this computing instance for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getOutboundPrivateBandwidthUsage/", + "operationId": "SoftLayer_Virtual_Guest::getOutboundPrivateBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getOutboundPublicBandwidthUsage": { + "get": { + "description": "The total public outbound bandwidth for this computing instance for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getOutboundPublicBandwidthUsage/", + "operationId": "SoftLayer_Virtual_Guest::getOutboundPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getOverBandwidthAllocationFlag": { + "get": { + "description": "Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getOverBandwidthAllocationFlag/", + "operationId": "SoftLayer_Virtual_Guest::getOverBandwidthAllocationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getPendingMigrationFlag": { + "get": { + "description": "When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getPendingMigrationFlag/", + "operationId": "SoftLayer_Virtual_Guest::getPendingMigrationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getPlacementGroup": { + "get": { + "description": "The placement group that a virtual guest belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getPlacementGroup/", + "operationId": "SoftLayer_Virtual_Guest::getPlacementGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_PlacementGroup" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getPowerState": { + "get": { + "description": "The current power state of a virtual guest.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getPowerState/", + "operationId": "SoftLayer_Virtual_Guest::getPowerState", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Power_State" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getPrimaryBackendIpAddress": { + "get": { + "description": "A guest's primary private IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendIpAddress/", + "operationId": "SoftLayer_Virtual_Guest::getPrimaryBackendIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getPrimaryBackendNetworkComponent": { + "get": { + "description": "A guest's primary backend network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendNetworkComponent/", + "operationId": "SoftLayer_Virtual_Guest::getPrimaryBackendNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getPrimaryIpAddress": { + "get": { + "description": "The guest's primary public IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getPrimaryIpAddress/", + "operationId": "SoftLayer_Virtual_Guest::getPrimaryIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getPrimaryNetworkComponent": { + "get": { + "description": "A guest's primary public network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getPrimaryNetworkComponent/", + "operationId": "SoftLayer_Virtual_Guest::getPrimaryNetworkComponent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getPrivateNetworkOnlyFlag": { + "get": { + "description": "Whether the computing instance only has access to the private network.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getPrivateNetworkOnlyFlag/", + "operationId": "SoftLayer_Virtual_Guest::getPrivateNetworkOnlyFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getProjectedOverBandwidthAllocationFlag": { + "get": { + "description": "Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getProjectedOverBandwidthAllocationFlag/", + "operationId": "SoftLayer_Virtual_Guest::getProjectedOverBandwidthAllocationFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getProjectedPublicBandwidthUsage": { + "get": { + "description": "The projected public outbound bandwidth for this computing instance for the current billing cycle.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getProjectedPublicBandwidthUsage/", + "operationId": "SoftLayer_Virtual_Guest::getProjectedPublicBandwidthUsage", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getRecentEvents": { + "get": { + "description": "Recent events that impact this computing instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getRecentEvents/", + "operationId": "SoftLayer_Virtual_Guest::getRecentEvents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Notification_Occurrence_Event" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getRegionalGroup": { + "get": { + "description": "The regional group this guest is in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getRegionalGroup/", + "operationId": "SoftLayer_Virtual_Guest::getRegionalGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location_Group_Regional" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getRegionalInternetRegistry": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getRegionalInternetRegistry/", + "operationId": "SoftLayer_Virtual_Guest::getRegionalInternetRegistry", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Regional_Internet_Registry" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getReservedCapacityGroup": { + "get": { + "description": "The reserved capacity group the guest is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroup/", + "operationId": "SoftLayer_Virtual_Guest::getReservedCapacityGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_ReservedCapacityGroup" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getReservedCapacityGroupFlag": { + "get": { + "description": "Flag to indicate whether or not a guest is part of a reserved capacity group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupFlag/", + "operationId": "SoftLayer_Virtual_Guest::getReservedCapacityGroupFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getReservedCapacityGroupInstance": { + "get": { + "description": "The reserved capacity group instance the guest is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupInstance/", + "operationId": "SoftLayer_Virtual_Guest::getReservedCapacityGroupInstance", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_ReservedCapacityGroup_Instance" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getSecurityScanRequests": { + "get": { + "description": "A guest's vulnerability scan requests.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getSecurityScanRequests/", + "operationId": "SoftLayer_Virtual_Guest::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_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getServerRoom": { + "get": { + "description": "The server room that a guest is located at. There may be more than one server room for every data center.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getServerRoom/", + "operationId": "SoftLayer_Virtual_Guest::getServerRoom", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getSoftwareComponents": { + "get": { + "description": "A guest's installed software.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getSoftwareComponents/", + "operationId": "SoftLayer_Virtual_Guest::getSoftwareComponents", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Component" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getSshKeys": { + "get": { + "description": "SSH keys to be installed on the server during provisioning or an OS reload.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getSshKeys/", + "operationId": "SoftLayer_Virtual_Guest::getSshKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getStatus": { + "get": { + "description": "A computing instance's status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getStatus/", + "operationId": "SoftLayer_Virtual_Guest::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getTagReferences": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getTagReferences/", + "operationId": "SoftLayer_Virtual_Guest::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getTransientGuestFlag": { + "get": { + "description": "Whether or not a computing instance is a Transient Instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getTransientGuestFlag/", + "operationId": "SoftLayer_Virtual_Guest::getTransientGuestFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getTransientWebhookURI": { + "get": { + "description": "The endpoint used to notify customers their transient guest is terminating.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getTransientWebhookURI/", + "operationId": "SoftLayer_Virtual_Guest::getTransientWebhookURI", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Attribute" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getType": { + "get": { + "description": "The type of this virtual guest.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getType/", + "operationId": "SoftLayer_Virtual_Guest::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getUpgradeRequest": { + "get": { + "description": "A computing instance's associated upgrade request object if any.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getUpgradeRequest/", + "operationId": "SoftLayer_Virtual_Guest::getUpgradeRequest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Product_Upgrade_Request" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getUserData": { + "get": { + "description": "A base64 encoded string containing custom user data for a Cloud Computing Instance order.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getUserData/", + "operationId": "SoftLayer_Virtual_Guest::getUserData", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Attribute" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getUsers": { + "get": { + "description": "A list of users that have access to this computing instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getUsers/", + "operationId": "SoftLayer_Virtual_Guest::getUsers", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_User_Customer" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getVirtualRack": { + "get": { + "description": "The name of the bandwidth allotment that a hardware belongs too.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getVirtualRack/", + "operationId": "SoftLayer_Virtual_Guest::getVirtualRack", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Bandwidth_Version1_Allotment" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getVirtualRackId": { + "get": { + "description": "The id of the bandwidth allotment that a computing instance belongs too.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getVirtualRackId/", + "operationId": "SoftLayer_Virtual_Guest::getVirtualRackId", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getVirtualRackName": { + "get": { + "description": "The name of the bandwidth allotment that a computing instance belongs too.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest/getVirtualRackName/", + "operationId": "SoftLayer_Virtual_Guest::getVirtualRackName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/addByolAttribute": { + "get": { + "description": "This method allows you to mark this image template as customer managed software license (BYOL) ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addByolAttribute/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::addByolAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/addCloudInitAttribute": { + "get": { + "description": "This method allows you to mark this image template as cloud init ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addCloudInitAttribute/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::addCloudInitAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/addLocations": { + "post": { + "description": "This method will create transaction(s) to add available locations to an archive image template.", + "summary": "[[SoftLayer_Virtual_Guest_Block_Device]] can be made available in all storage locations. This method will create transaction(s) to add available locations to an archive image template. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addLocations/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::addLocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/addSupportedBootMode": { + "post": { + "description": "This method allows you to mark this image's supported boot modes as 'HVM' or 'PV'. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addSupportedBootMode/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::addSupportedBootMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/copyToExternalSource": { + "post": { + "description": "Create a transaction to export/copy a template to an external source.", + "summary": "This method generates a transaction to export/copy a template to an external source. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToExternalSource/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::copyToExternalSource", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/copyToIcos": { + "post": { + "description": "Create a transaction to export/copy a template to an ICOS.", + "summary": "This method generates a transaction to export/copy a template to IBM Cloud Object Storage (ICOS) ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToIcos/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::copyToIcos", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromExternalSource": { + "post": { + "description": "Create a transaction to import a disk image from an external source and create a standard image template.", + "summary": "This method generates a transaction to import a disk image from an external source and create a standard image template. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromExternalSource/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::createFromExternalSource", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromIcos": { + "post": { + "description": "Create a process to import a disk image from ICOS and create a standard", + "summary": "This method generates a process instance to import a disk image from ICOS and create a standard image template. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromIcos/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::createFromIcos", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/createPublicArchiveTransaction": { + "post": { + "description": "Create a transaction to copy archived block devices into public repository", + "summary": "[[SoftLayer_Virtual_Guest_Block_Device]] can be published together in a public repository for use by everyone. This method generates a transaction to perform a public image of the provided archived block devices. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createPublicArchiveTransaction/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::createPublicArchiveTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "int" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/deleteByolAttribute": { + "get": { + "description": "This method allows you to remove BYOL attribute for a given image template. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteByolAttribute/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::deleteByolAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/deleteCloudInitAttribute": { + "get": { + "description": "This method allows you to remove cloud init attribute for a given image template. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteCloudInitAttribute/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::deleteCloudInitAttribute", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/deleteObject": { + "get": { + "description": "Deleting a block device template group is different from the deletion of other objects. A block device template group can contain several gigabytes of data in its disk images. This may take some time to delete and requires a transaction to be created. This method creates a transaction that will delete all resources associated with the block device template group. ", + "summary": "Create a transaction that will remove all block device templates from the group and delete the disk images associated with them. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteObject/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/denySharingAccess": { + "post": { + "description": "This method will deny another SoftLayer customer account's previously given access to provision CloudLayer Computing Instances from an image template group. Template access should only be removed from the parent template group object, not the child. ", + "summary": "Deny another SoftLayer customer account's previously given access to provision CloudLayer Computing Instances from an image template group. Template access should only be removed from the parent template group object, not the child. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/denySharingAccess/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::denySharingAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/editObject": { + "post": { + "description": "Edit an image template group's associated name and note. All other properties in the SoftLayer_Virtual_Guest_Block_Device_Template_Group data type are read-only. ", + "summary": "Edit an image template group's name and note.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/editObject/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/findGcImagesByCurrentUser": { + "post": { + "description": "Find block device template groups containing a GC enabled cloudinit image for the current active user. A sorted collection of groups is returned. The Caller can optionally specify data center or region names to retrieve GC images from only those locations. ", + "summary": "Fetch a sorted collection of GC enabled cloudinit images for the account of the current active customer user. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/findGcImagesByCurrentUser/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::findGcImagesByCurrentUser", + "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_Virtual_Guest_Block_Device_Template_Group/getAllAvailableCompatiblePlatformNames": { + "get": { + "description": "Get all available compatible platform names that can be added to a template group. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAllAvailableCompatiblePlatformNames/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getAllAvailableCompatiblePlatformNames", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getBootMode": { + "get": { + "description": "This method returns the boot mode, if any, set on a given image template. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBootMode/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getBootMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getCurrentCompatiblePlatformNames": { + "get": { + "description": "Get compatible platform names currently set on the template group. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getCurrentCompatiblePlatformNames/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getCurrentCompatiblePlatformNames", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getDefaultBootMode": { + "get": { + "description": "This method returns the default boot mode set by the software description ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDefaultBootMode/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getDefaultBootMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getEncryptionAttributes": { + "get": { + "description": "This method returns an array of encryption values, or empty array if none are found ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getEncryptionAttributes/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getEncryptionAttributes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_Guest_Block_Device_Template_Group record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getObject/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicCustomerOwnedImages": { + "get": { + "description": "This method gets all public customer owned image templates that the user is allowed to see. ", + "summary": "Gets all public customer owned image templates that the user is allowed to see. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicCustomerOwnedImages/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getPublicCustomerOwnedImages", + "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_Virtual_Guest_Block_Device_Template_Group/getPublicImages": { + "get": { + "description": "This method gets all public image templates that the user is allowed to see. ", + "summary": "Gets all public image templates that the user is allowed to see. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getPublicImages", + "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_Virtual_Guest_Block_Device_Template_Group/getRiasAccount": { + "post": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRiasAccount/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getRiasAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getStorageLocations": { + "get": { + "description": "Returns the image storage locations. ", + "summary": "The available locations for public image storage. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageLocations/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getStorageLocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getSupportedBootModes": { + "get": { + "description": "This method indicates which boot modes are supported by the image. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSupportedBootModes/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getSupportedBootModes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getTemplateDataCenterName": { + "get": { + "description": "This method allows you to grab the first data center that the image(s) reside on so we can pull it from there. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTemplateDataCenterName/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getTemplateDataCenterName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/getVhdImportSoftwareDescriptions": { + "get": { + "description": "Returns an array of SoftLayer_Software_Description that are supported for VHD imports. ", + "summary": "Returns the software descriptions supported for VHD imports.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getVhdImportSoftwareDescriptions/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getVhdImportSoftwareDescriptions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Software_Description" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/isByol": { + "get": { + "description": "This method indicates whether or not this image is a customer supplied license image. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByol/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::isByol", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/isByolCapableOperatingSystem": { + "get": { + "description": "This method indicates whether or not this image uses an operating system capable of using a customer supplied license image. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolCapableOperatingSystem/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::isByolCapableOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/isByolOnlyOperatingSystem": { + "get": { + "description": "This method indicates whether or not this image uses an operating system that requires using a customer supplied license image ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolOnlyOperatingSystem/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::isByolOnlyOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/isCloudInit": { + "get": { + "description": "This method indicates whether or not this image is a cloud-init image. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInit/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::isCloudInit", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/isCloudInitOnlyOperatingSystem": { + "get": { + "description": "This method indicates whether or not this image uses an operating system that requires cloud init ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInitOnlyOperatingSystem/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::isCloudInitOnlyOperatingSystem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/isEncrypted": { + "get": { + "description": "This method indicates whether this image template contains an encrypted disk image. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isEncrypted/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::isEncrypted", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/permitSharingAccess": { + "post": { + "description": "This method will permit another SoftLayer customer account access to provision CloudLayer Computing Instances from an image template group. Template access should only be given to the parent template group object, not the child. ", + "summary": "Permit another SoftLayer customer account access to provision CloudLayer Computing Instances from an image template group. Template access should only be given to the parent template group object, not the child. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/permitSharingAccess/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::permitSharingAccess", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/removeCompatiblePlatforms": { + "post": { + "description": "Removes compatible platforms on the template group. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeCompatiblePlatforms/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::removeCompatiblePlatforms", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/removeLocations": { + "post": { + "description": "This method will create transaction(s) to remove available locations from an archive image template.", + "summary": "[[SoftLayer_Virtual_Guest_Block_Device]] can be made available in all storage locations. This method will create transaction(s) to remove available locations from an archive image template. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeLocations/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::removeLocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/removeSupportedBootMode": { + "post": { + "description": "This method allows you to remove a supported boot mode attribute for a given image template. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeSupportedBootMode/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::removeSupportedBootMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/setAvailableLocations": { + "post": { + "description": "Create transaction(s) to set the archived block device available locations", + "summary": "This method generates the necessary transaction(s) to set available locations for archived block devices. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setAvailableLocations/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::setAvailableLocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/setBootMode": { + "post": { + "description": "This method allows you to specify the boot mode for a given image template. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setBootMode/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::setBootMode", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/setCompatiblePlatforms": { + "post": { + "description": "Sets compatible platforms on the template group. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setCompatiblePlatforms/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::setCompatiblePlatforms", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/setTags": { + "post": { + "description": "Set the tags for this template group.", + "summary": "Set the tags for this template group.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setTags/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::setTags", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getAccount": { + "get": { + "description": "A block device template group's [[SoftLayer_Account|account]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccount/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getAccountContacts": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountContacts/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getAccountContacts", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Account_Contact" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getAccountReferences": { + "get": { + "description": "The accounts which may have read-only access to an image template group. Will only be populated for parent template group objects.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountReferences/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getAccountReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getBlockDevices": { + "get": { + "description": "The block devices that are part of an image template group", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevices/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getBlockDevices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getBlockDevicesDiskSpaceTotal": { + "get": { + "description": "The total disk space of all images in a image template group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevicesDiskSpaceTotal/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getBlockDevicesDiskSpaceTotal", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getByolFlag": { + "get": { + "description": "A flag indicating that customer is providing the software licenses.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getByolFlag/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getByolFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getChildren": { + "get": { + "description": "The image template groups that are clones of an image template group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getChildren/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getChildren", + "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_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getDatacenter": { + "get": { + "description": "The location containing this image template group. Will only be populated for child template group objects.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenter/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getDatacenters": { + "get": { + "description": "A collection of locations containing a copy of this image template group. Will only be populated for parent template group objects.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenters/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getDatacenters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getFirstChild": { + "get": { + "description": "The first clone of the image template group", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFirstChild/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getFirstChild", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getFlexImageFlag": { + "get": { + "description": "A flag indicating if this is a flex image.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFlexImageFlag/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getFlexImageFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getGlobalIdentifier": { + "get": { + "description": "An image template's universally unique identifier.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getGlobalIdentifier/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getGlobalIdentifier", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getImageType": { + "get": { + "description": "The virtual disk image type of this template. Value will be populated on parent and child, but only supports object filtering on the parent.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageType/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getImageType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getImageTypeKeyName": { + "get": { + "description": "The virtual disk image type keyname (e.g. SYSTEM, DISK_CAPTURE, ISO, etc) of this template. Value will be populated on parent and child, but only supports object filtering on the parent.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageTypeKeyName/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getImageTypeKeyName", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getNextGenFlag": { + "get": { + "description": "A flag indicating if this is a next generation image.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getNextGenFlag/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getNextGenFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getParent": { + "get": { + "description": "The image template group that another image template group was cloned from.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getParent/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getParent", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getRegion": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegion/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getRegion", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getRegions": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegions/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getRegions", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Service_Resource" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getSshKeys": { + "get": { + "description": "The ssh keys to be implemented on the server when provisioned or reloaded from an image template group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSshKeys/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getSshKeys", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Security_Ssh_Key" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getStatus": { + "get": { + "description": "A template group's status.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStatus/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getStatus", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getStorageRepository": { + "get": { + "description": "The storage repository that an image template group resides on.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageRepository/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getStorageRepository", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Storage_Repository" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getTagReferences": { + "get": { + "description": "The tags associated with this image template group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTagReferences/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getTagReferences", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Tag_Reference" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Block_Device_Template_Group/{SoftLayer_Virtual_Guest_Block_Device_Template_GroupID}/getTransaction": { + "get": { + "description": "A transaction that is being performed on a image template group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTransaction/", + "operationId": "SoftLayer_Virtual_Guest_Block_Device_Template_Group::getTransaction", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Provisioning_Version1_Transaction" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Boot_Parameter/createObject": { + "post": { + "description": null, + "summary": "Create a boot parameter record to be used at next boot", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/createObject/", + "operationId": "SoftLayer_Virtual_Guest_Boot_Parameter::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Boot_Parameter/{SoftLayer_Virtual_Guest_Boot_ParameterID}/deleteObject": { + "get": { + "description": null, + "summary": "Removes a boot parameter", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/deleteObject/", + "operationId": "SoftLayer_Virtual_Guest_Boot_Parameter::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Boot_Parameter/{SoftLayer_Virtual_Guest_Boot_ParameterID}/editObject": { + "post": { + "description": null, + "summary": "Edits a single boot parameter", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/editObject/", + "operationId": "SoftLayer_Virtual_Guest_Boot_Parameter::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Boot_Parameter/{SoftLayer_Virtual_Guest_Boot_ParameterID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_Guest_Boot_Parameter record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getObject/", + "operationId": "SoftLayer_Virtual_Guest_Boot_Parameter::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Boot_Parameter" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Boot_Parameter/{SoftLayer_Virtual_Guest_Boot_ParameterID}/getGuest": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuest/", + "operationId": "SoftLayer_Virtual_Guest_Boot_Parameter::getGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Boot_Parameter/{SoftLayer_Virtual_Guest_Boot_ParameterID}/getGuestBootParameterType": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuestBootParameterType/", + "operationId": "SoftLayer_Virtual_Guest_Boot_Parameter::getGuestBootParameterType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Boot_Parameter_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Boot_Parameter_Type/getAllObjects": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getAllObjects/", + "operationId": "SoftLayer_Virtual_Guest_Boot_Parameter_Type::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Boot_Parameter_Type" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Boot_Parameter_Type/{SoftLayer_Virtual_Guest_Boot_Parameter_TypeID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_Guest_Boot_Parameter_Type record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getObject/", + "operationId": "SoftLayer_Virtual_Guest_Boot_Parameter_Type::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Boot_Parameter_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/disable": { + "get": { + "description": "Completely restrict all incoming and outgoing bandwidth traffic to a network component ", + "summary": "Disable a network component to restrict network traffic", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/disable/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::disable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/enable": { + "get": { + "description": "Allow incoming and outgoing bandwidth traffic to a network component ", + "summary": "Enable a network component to allow network traffic", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/enable/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::enable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_Guest_Network_Component record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getObject/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/isPingable": { + "get": { + "description": "Issues a ping command and returns the success (true) or failure (false) of the ping command. ", + "summary": "Verifies if network component is pingable.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/isPingable/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::isPingable", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/securityGroupsReady": { + "get": { + "description": null, + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/securityGroupsReady/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::securityGroupsReady", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getGuest": { + "get": { + "description": "The computing instance that this network component exists on.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getGuest/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getHighAvailabilityFirewallFlag": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getHighAvailabilityFirewallFlag/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getHighAvailabilityFirewallFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getIcpBinding": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIcpBinding/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getIcpBinding", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component_IcpBinding" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getIpAddressBindings": { + "get": { + "description": "The records of all IP addresses bound to a computing instance's network component.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIpAddressBindings/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getIpAddressBindings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest_Network_Component_IpAddress" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getNetworkComponentFirewall": { + "get": { + "description": "The upstream network component firewall.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkComponentFirewall/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getNetworkComponentFirewall", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Component_Firewall" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getNetworkVlan": { + "get": { + "description": "The VLAN that a computing instance network component's subnet is associated with.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkVlan/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getNetworkVlan", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Vlan" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getPrimaryIpAddress": { + "get": { + "description": "A computing instance network component's primary IP address.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddress/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getPrimaryIpAddress", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getPrimaryIpAddressRecord": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddressRecord/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getPrimaryIpAddressRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getPrimarySubnet": { + "get": { + "description": "A network component's subnet for its primary IP address", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimarySubnet/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getPrimarySubnet", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getPrimaryVersion6IpAddressRecord": { + "get": { + "description": "A network component's primary IPv6 IP address record.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryVersion6IpAddressRecord/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getPrimaryVersion6IpAddressRecord", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet_IpAddress" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getRouter": { + "get": { + "description": "A network component's routers.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getRouter/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getRouter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Router" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getSecurityGroupBindings": { + "get": { + "description": "The bindings associating security groups to this network component", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSecurityGroupBindings/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getSecurityGroupBindings", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Guest_Network_Component/{SoftLayer_Virtual_Guest_Network_ComponentID}/getSubnets": { + "get": { + "description": "A network component's subnets. A subnet is a group of IP addresses", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSubnets/", + "operationId": "SoftLayer_Virtual_Guest_Network_Component::getSubnets", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Network_Subnet" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Host/{SoftLayer_Virtual_HostID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_Host record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Host/getObject/", + "operationId": "SoftLayer_Virtual_Host::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Host/{SoftLayer_Virtual_HostID}/getAccount": { + "get": { + "description": "The account which a virtual host belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Host/getAccount/", + "operationId": "SoftLayer_Virtual_Host::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Host/{SoftLayer_Virtual_HostID}/getHardware": { + "get": { + "description": "The hardware record which a virtual host resides on.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Host/getHardware/", + "operationId": "SoftLayer_Virtual_Host::getHardware", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Server" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Host/{SoftLayer_Virtual_HostID}/getMetricTrackingObject": { + "get": { + "description": "The metric tracking object for this virtual host.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Host/getMetricTrackingObject/", + "operationId": "SoftLayer_Virtual_Host::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Host/{SoftLayer_Virtual_HostID}/getPciDevices": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Host/getPciDevices/", + "operationId": "SoftLayer_Virtual_Host::getPciDevices", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Host_PciDevice" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup/createObject": { + "post": { + "description": "Add a placement group to your account for use during VSI provisioning. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup/createObject/", + "operationId": "SoftLayer_Virtual_PlacementGroup::createObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_PlacementGroup" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup/{SoftLayer_Virtual_PlacementGroupID}/deleteObject": { + "get": { + "description": "Delete a placement group from your account. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup/deleteObject/", + "operationId": "SoftLayer_Virtual_PlacementGroup::deleteObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup/{SoftLayer_Virtual_PlacementGroupID}/editObject": { + "post": { + "description": "Update a placement group. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup/editObject/", + "operationId": "SoftLayer_Virtual_PlacementGroup::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup/getAvailableRouters": { + "post": { + "description": "Returns all routers available for use with placement groups. If a datacenter location ID is provided, this method will further restrict the list of routers to ones contained within that datacenter. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup/getAvailableRouters/", + "operationId": "SoftLayer_Virtual_PlacementGroup::getAvailableRouters", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Hardware" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup/{SoftLayer_Virtual_PlacementGroupID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_PlacementGroup record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup/getObject/", + "operationId": "SoftLayer_Virtual_PlacementGroup::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_PlacementGroup" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup/{SoftLayer_Virtual_PlacementGroupID}/getAccount": { + "get": { + "description": "The account that the placement group is implemented on.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup/getAccount/", + "operationId": "SoftLayer_Virtual_PlacementGroup::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup/{SoftLayer_Virtual_PlacementGroupID}/getBackendRouter": { + "get": { + "description": "The router the placement group is implemented on.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup/getBackendRouter/", + "operationId": "SoftLayer_Virtual_PlacementGroup::getBackendRouter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Router_Backend" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup/{SoftLayer_Virtual_PlacementGroupID}/getGuests": { + "get": { + "description": "The virtual guests that are members of the placement group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup/getGuests/", + "operationId": "SoftLayer_Virtual_PlacementGroup::getGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup/{SoftLayer_Virtual_PlacementGroupID}/getRule": { + "get": { + "description": "The placement rule that the placement group is implementing.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup/getRule/", + "operationId": "SoftLayer_Virtual_PlacementGroup::getRule", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_PlacementGroup_Rule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup_Rule/getAllObjects": { + "get": { + "description": "Get all placement group rules.", + "summary": "Get all placement group rules.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getAllObjects/", + "operationId": "SoftLayer_Virtual_PlacementGroup_Rule::getAllObjects", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_PlacementGroup_Rule" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_PlacementGroup_Rule/{SoftLayer_Virtual_PlacementGroup_RuleID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_PlacementGroup_Rule record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getObject/", + "operationId": "SoftLayer_Virtual_PlacementGroup_Rule::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_PlacementGroup_Rule" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup/{SoftLayer_Virtual_ReservedCapacityGroupID}/editObject": { + "post": { + "description": "Update a reserved capacity group. ", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/editObject/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup::editObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup/{SoftLayer_Virtual_ReservedCapacityGroupID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_ReservedCapacityGroup record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getObject/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_ReservedCapacityGroup" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup/{SoftLayer_Virtual_ReservedCapacityGroupID}/getAccount": { + "get": { + "description": "The account that the reserved capacity group is implemented on.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAccount/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup/{SoftLayer_Virtual_ReservedCapacityGroupID}/getAvailableInstances": { + "get": { + "description": "The instances available for guest provisions on this reserved capacity group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAvailableInstances/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup::getAvailableInstances", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_ReservedCapacityGroup_Instance" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup/{SoftLayer_Virtual_ReservedCapacityGroupID}/getBackendRouter": { + "get": { + "description": "The router the reserved capacity group is implemented on.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getBackendRouter/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup::getBackendRouter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Hardware_Router_Backend" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup/{SoftLayer_Virtual_ReservedCapacityGroupID}/getInstances": { + "get": { + "description": "The guest instances that are members of this reserved capacity group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstances/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup::getInstances", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_ReservedCapacityGroup_Instance" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup/{SoftLayer_Virtual_ReservedCapacityGroupID}/getInstancesCount": { + "get": { + "description": "The number of instances that are members of this reserved capacity group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstancesCount/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup::getInstancesCount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "unsignedInt" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup/{SoftLayer_Virtual_ReservedCapacityGroupID}/getOccupiedInstances": { + "get": { + "description": "The instances already occupied by a guest on this reserved capacity group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getOccupiedInstances/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup::getOccupiedInstances", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_ReservedCapacityGroup_Instance" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup_Instance/{SoftLayer_Virtual_ReservedCapacityGroup_InstanceID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_ReservedCapacityGroup_Instance record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getObject/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup_Instance::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_ReservedCapacityGroup_Instance" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup_Instance/{SoftLayer_Virtual_ReservedCapacityGroup_InstanceID}/getAvailableFlag": { + "get": { + "description": "Flag to indecate whether or not the reserved instance is available or not.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getAvailableFlag/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup_Instance::getAvailableFlag", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup_Instance/{SoftLayer_Virtual_ReservedCapacityGroup_InstanceID}/getBillingItem": { + "get": { + "description": "The billing item for the reserved capacity group instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getBillingItem/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup_Instance::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup_Instance/{SoftLayer_Virtual_ReservedCapacityGroup_InstanceID}/getGuest": { + "get": { + "description": "The virtual guest associated with this reserved capacity group instance.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getGuest/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup_Instance::getGuest", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_ReservedCapacityGroup_Instance/{SoftLayer_Virtual_ReservedCapacityGroup_InstanceID}/getReservedCapacityGroup": { + "get": { + "description": "The reserved instances that are members of this reserved capacity group.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getReservedCapacityGroup/", + "operationId": "SoftLayer_Virtual_ReservedCapacityGroup_Instance::getReservedCapacityGroup", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_ReservedCapacityGroup" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getArchiveDiskUsageRatePerGb": { + "get": { + "description": "Returns the archive storage disk usage fee rate per gigabyte. ", + "summary": "The rate that is charged for archiving every 1 gigabyte of data for a computing instance ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getArchiveDiskUsageRatePerGb/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getArchiveDiskUsageRatePerGb", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getAverageDiskUsageMetricDataFromInfluxByDate": { + "post": { + "description": "Returns the average disk space usage for a storage repository. ", + "summary": "Returns the average disk usage for the timeframe based on the parameters provided. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageDiskUsageMetricDataFromInfluxByDate/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getAverageDiskUsageMetricDataFromInfluxByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getAverageUsageMetricDataByDate": { + "post": { + "description": "Returns the average disk space usage for a storage repository. ", + "summary": "Returns the average disk usage for the timeframe based on the parameters provided. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getAverageUsageMetricDataByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "float" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getObject": { + "get": { + "description": null, + "summary": "Retrieve a SoftLayer_Virtual_Storage_Repository record.", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getObject/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Storage_Repository" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getPublicImageDiskUsageRatePerGb": { + "get": { + "description": "Returns the public image storage disk usage fee rate per gigabyte. ", + "summary": "The rate that is charged for publishing every 1 gigabyte of data for an image template ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageDiskUsageRatePerGb/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getPublicImageDiskUsageRatePerGb", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "decimal" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getStorageLocations": { + "get": { + "description": "Returns the public image storage locations. ", + "summary": "The available locations for public image storage. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getStorageLocations/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getStorageLocations", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getUsageMetricDataByDate": { + "post": { + "description": "Retrieve disk usage data on a [[SoftLayer_Virtual_Guest|Cloud Computing Instance]] image for the time range you provide. Each data entry objects contain ''dateTime'' and ''counter'' properties. ''dateTime'' property indicates the time that the disk usage data was measured and ''counter'' property holds the disk usage in bytes. ", + "summary": "Retrieve the metric data for disk space usage for a storage repository. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getUsageMetricDataByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Data" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getUsageMetricImageByDate": { + "post": { + "description": "Returns a disk usage image based on disk usage specified by the input parameters. ", + "summary": "Retrieve an image of the disk usage data on a [[SoftLayer_Virtual_Guest|Cloud Computing Instance]] image for the time range you provide. ", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getUsageMetricImageByDate", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Container_Bandwidth_GraphOutputs" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getAccount": { + "get": { + "description": "The [[SoftLayer_Account|account]] that a storage repository belongs to.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getAccount/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getAccount", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Account" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getBillingItem": { + "get": { + "description": "The current billing item for a storage repository.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getBillingItem/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getDatacenter": { + "get": { + "description": "The datacenter that a virtual storage repository resides in.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getDatacenter/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getDatacenter", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Location" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getDiskImages": { + "get": { + "description": "The [[SoftLayer_Virtual_Disk_Image|disk images]] that are in a storage repository. Disk images are the virtual hard drives for a virtual guest.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getDiskImages/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getDiskImages", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Disk_Image" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getGuests": { + "get": { + "description": "The computing instances that have disk images in a storage repository.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getGuests/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getGuests", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Guest" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getMetricTrackingObject": { + "get": { + "description": "", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getMetricTrackingObject/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getMetricTrackingObject", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getPublicImageBillingItem": { + "get": { + "description": "The current billing item for a public storage repository.", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageBillingItem/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getPublicImageBillingItem", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Billing_Item" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getType": { + "get": { + "description": "A storage repository's [[SoftLayer_Virtual_Storage_Repository_Type|type]].", + "summary": "", + "externalDocs": "https://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Storage_Repository/getType/", + "operationId": "SoftLayer_Virtual_Storage_Repository::getType", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SoftLayer_Virtual_Storage_Repository_Type" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + } + }, + "components": { + "schemas": {}, + "requestBodies": {}, + "securitySchemes": { + "api_key": { + "type": "apiKey", + "name": "api_key", + "in": "header" + } + } + } +} \ No newline at end of file diff --git a/openapi/sldn_metadata.json b/openapi/sldn_metadata.json new file mode 100644 index 0000000000..44005de8dd --- /dev/null +++ b/openapi/sldn_metadata.json @@ -0,0 +1,262865 @@ +{ + "BMS_Container_Country": { + "name": "BMS_Container_Country", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "code": { + "name": "code", + "type": "string", + "form": "local" + }, + "id": { + "name": "id", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "BluePages_Container_EmployeeProfile": { + "name": "BluePages_Container_EmployeeProfile", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "address1": { + "name": "address1", + "type": "string", + "form": "local", + "doc": "Employee address " + }, + "address2": { + "name": "address2", + "type": "string", + "form": "local", + "doc": "Employee address " + }, + "addressCountry": { + "name": "addressCountry", + "type": "string", + "form": "local", + "doc": "Country of employee's address " + }, + "city": { + "name": "city", + "type": "string", + "form": "local", + "doc": "Employee city " + }, + "departmentCode": { + "name": "departmentCode", + "type": "string", + "form": "local", + "doc": "Employee department code " + }, + "departmentCountry": { + "name": "departmentCountry", + "type": "string", + "form": "local", + "doc": "Employee department country code " + }, + "departmentCountryId": { + "name": "departmentCountryId", + "type": "string", + "form": "local", + "doc": "Employee department country code ID " + }, + "divisionCode": { + "name": "divisionCode", + "type": "string", + "form": "local", + "doc": "Employee division code " + }, + "emailAddress": { + "name": "emailAddress", + "type": "string", + "form": "local", + "doc": "Employee email address " + }, + "firstName": { + "name": "firstName", + "type": "string", + "form": "local", + "doc": "Employee first name " + }, + "lastName": { + "name": "lastName", + "type": "string", + "form": "local", + "doc": "Employee last name " + }, + "managerEmailAddress": { + "name": "managerEmailAddress", + "type": "string", + "form": "local", + "doc": "Email of employee's manager " + }, + "managerFirstName": { + "name": "managerFirstName", + "type": "string", + "form": "local", + "doc": "Employee's manager's first name " + }, + "managerLastName": { + "name": "managerLastName", + "type": "string", + "form": "local", + "doc": "Employee's manager's last name " + }, + "managerUid": { + "name": "managerUid", + "type": "string", + "form": "local", + "doc": "Employee' manager's identifier " + }, + "phone": { + "name": "phone", + "type": "string", + "form": "local", + "doc": "Employee phone number " + }, + "postalCode": { + "name": "postalCode", + "type": "string", + "form": "local", + "doc": "Employee postal code " + }, + "state": { + "name": "state", + "type": "string", + "form": "local", + "doc": "Employee state " + }, + "uid": { + "name": "uid", + "type": "string", + "form": "local", + "doc": "Employee identifier " + } + }, + "methods": {} + }, + "BluePages_Search": { + "name": "BluePages_Search", + "base": "SoftLayer_Entity", + "serviceDoc": "Searches BluePages for an employee and returns a container representing the employee. Note that this service is not available to customers, despite being visible, and will return an error response. ", + "methods": { + "findBluePagesProfile": { + "name": "findBluePagesProfile", + "type": "BluePages_Container_EmployeeProfile", + "doc": "Given an IBM email address, searches BluePages and returns the employee's details. Note that this method is not available to customers, despite being visible, and will return an error response. ", + "static": true, + "parameters": [ + { + "name": "emailAddress", + "type": "string" + } + ] + } + }, + "properties": {} + }, + "IntegratedOfferingTeam_Container_Region": { + "name": "IntegratedOfferingTeam_Container_Region", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "keyName": { + "name": "keyName", + "type": "string", + "form": "local" + }, + "name": { + "name": "name", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "IntegratedOfferingTeam_Container_Region_Lead": { + "name": "IntegratedOfferingTeam_Container_Region_Lead", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "emailAddress": { + "name": "emailAddress", + "type": "string", + "form": "local", + "doc": "Regional lead's email address" + }, + "firstName": { + "name": "firstName", + "type": "string", + "form": "local", + "doc": "Regional lead's first name" + }, + "lastName": { + "name": "lastName", + "type": "string", + "form": "local", + "doc": "Regional lead's last name" + }, + "regionKeyName": { + "name": "regionKeyName", + "type": "string", + "form": "local", + "doc": "Key name of the region this lead is in charge of" + }, + "regionName": { + "name": "regionName", + "type": "string", + "form": "local", + "doc": "Full name of the region this lead is in charge of" + } + }, + "methods": {} + }, + "IntegratedOfferingTeam_Region": { + "name": "IntegratedOfferingTeam_Region", + "base": "SoftLayer_Entity", + "serviceDoc": "This class represents an Integrated Offering Team region. ", + "methods": { + "getAllObjects": { + "name": "getAllObjects", + "type": "IntegratedOfferingTeam_Container_Region", + "typeArray": true, + "doc": "Returns a list of all Integrated Offering Team regions. Note that this method, despite being visible, is not accessible by customers and attempting to use it will result in an error response. ", + "static": true, + "limitable": true, + "filterable": true, + "maskable": true + }, + "getRegionLeads": { + "name": "getRegionLeads", + "type": "IntegratedOfferingTeam_Container_Region_Lead", + "typeArray": true, + "doc": "Returns a list of all Integrated Offering Team region leads. Note that this method, despite being visible, is not accessible by customers and attempting to use it will result in an error response. ", + "static": true + } + }, + "typeDoc": "This class represents an Integrated Offering Team region. ", + "properties": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Agent_Details": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Agent_Details", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Agent_Details data type represents a virus scan agent and contains details about its version.", + "properties": { + "currentPolicy": { + "name": "currentPolicy", + "type": "McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details", + "form": "relational", + "doc": "The current anti-virus policy of an agent." + }, + "agentVersion": { + "name": "agentVersion", + "type": "string", + "form": "local", + "doc": "Version number of the anti-virus scan agent." + }, + "lastUpdate": { + "name": "lastUpdate", + "type": "string", + "form": "local", + "doc": "The date of the last time the anti-virus agent checked in." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details data type contains the name of an anti-virus policy.", + "properties": { + "currentPolicy": { + "name": "currentPolicy", + "type": "McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details", + "form": "relational", + "doc": "The current anti-virus policy of an agent." + }, + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name of a policy." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event data type represents a single anti-virus event. It contains details about the event such as the date the event occurred, the virus that is detected and the action that is taken. ", + "properties": { + "virusActionTaken": { + "name": "virusActionTaken", + "type": "McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description", + "form": "relational", + "doc": "The action taken when a virus is detected." + }, + "eventLocalDateTime": { + "name": "eventLocalDateTime", + "type": "dateTime", + "form": "local", + "doc": "The date when an anti-virus event occurs." + }, + "filename": { + "name": "filename", + "type": "string", + "form": "local", + "doc": "Name of the file found to be infected." + }, + "virusName": { + "name": "virusName", + "type": "string", + "form": "local", + "doc": "The name of a virus that is found." + }, + "virusType": { + "name": "virusType", + "type": "string", + "form": "local", + "doc": "The type of virus that is found." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection data type represents an access protection event. It contains details about the event such as when it occurs, the process that caused it, and the rule that triggered the event. ", + "properties": { + "eventLocalDateTime": { + "name": "eventLocalDateTime", + "type": "dateTime", + "form": "local", + "doc": "The date that an access protection event occurs." + }, + "filename": { + "name": "filename", + "type": "string", + "form": "local", + "doc": "The name of the file that was protected from access." + }, + "processName": { + "name": "processName", + "type": "string", + "form": "local", + "doc": "The name of the process that was protected from access." + }, + "ruleName": { + "name": "ruleName", + "type": "string", + "form": "local", + "doc": "The name of the rule that triggered an access protection event." + }, + "source": { + "name": "source", + "type": "string", + "form": "local", + "doc": "The IP address that caused an access protection event." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description data type contains the name of the rule that was triggered by an anti-virus event.", + "properties": { + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name of the rule that triggered an anti-virus event." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent data type contains a single blocked application event. The details of the event are the time the event occurred, the process that generated the event and a brief description of the application that was blocked. ", + "properties": { + "applicationDescription": { + "name": "applicationDescription", + "type": "string", + "form": "local", + "doc": "A brief description of the application that is blocked." + }, + "incidentTime": { + "name": "incidentTime", + "type": "dateTime", + "form": "local", + "doc": "The time that an application is blocked." + }, + "processName": { + "name": "processName", + "type": "string", + "form": "local", + "doc": "The name of a process that is blocked." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature data type contains the signature name of a rule that generated an IPS event.", + "properties": { + "signatureName": { + "name": "signatureName", + "type": "string", + "form": "local", + "doc": "The name of a rule that triggered an IPS event." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent data type represents a single IPS event. It contains details about the event such as the date the event occurred, the process that generated it, the severity of the event, and the action taken. ", + "properties": { + "signature": { + "name": "signature", + "type": "McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature", + "form": "relational", + "doc": "The signature that generated an IPS event." + }, + "incidentTime": { + "name": "incidentTime", + "type": "dateTime", + "form": "local", + "doc": "The time when an IPS event occurred." + }, + "processName": { + "name": "processName", + "type": "string", + "form": "local", + "doc": "Name of the process that generated an IPS event." + }, + "reactionText": { + "name": "reactionText", + "type": "string", + "form": "local", + "doc": "The action taken because of an IPS event." + }, + "remoteIpAddress": { + "name": "remoteIpAddress", + "type": "string", + "form": "local", + "doc": "The IP address that generated an IPS event." + }, + "severityText": { + "name": "severityText", + "type": "string", + "form": "local", + "doc": "The severity level for an IPS event." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent data type contains a single blocked application event. The details of the event are the time the event occurred, the process that generated the event and a brief description of the application that was blocked. ", + "properties": { + "applicationDescription": { + "name": "applicationDescription", + "type": "string", + "form": "local", + "doc": "A brief description of the application that is blocked." + }, + "incidentTime": { + "name": "incidentTime", + "type": "dateTime", + "form": "local", + "doc": "The time that an application is blocked." + }, + "processName": { + "name": "processName", + "type": "string", + "form": "local", + "doc": "The name of a process that is blocked." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature data type contains the signature name of a rule that generated an IPS event.", + "properties": { + "signatureName": { + "name": "signatureName", + "type": "string", + "form": "local", + "doc": "The name of a rule that triggered an IPS event." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent data type represents a single IPS event. It contains details about the event such as the date the event occurred, the process that generated it, the severity of the event, and the action taken. ", + "properties": { + "signature": { + "name": "signature", + "type": "McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature", + "form": "relational", + "doc": "The signature that generated an IPS event." + }, + "incidentTime": { + "name": "incidentTime", + "type": "dateTime", + "form": "local", + "doc": "The time when an IPS event occurred." + }, + "processName": { + "name": "processName", + "type": "string", + "form": "local", + "doc": "Name of the process that generated an IPS event." + }, + "reactionText": { + "name": "reactionText", + "type": "string", + "form": "local", + "doc": "The action taken because of an IPS event." + }, + "remoteIpAddress": { + "name": "remoteIpAddress", + "type": "string", + "form": "local", + "doc": "The IP address that generated an IPS event." + }, + "severityText": { + "name": "severityText", + "type": "string", + "form": "local", + "doc": "The severity level for an IPS event." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Policy_Object": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Policy_Object", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Policy_Object data type contains the name of a policy that may be assigned to a server.", + "properties": { + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name of a policy." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version36_Product_Properties": { + "name": "McAfee_Epolicy_Orchestrator_Version36_Product_Properties", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version36_Product_Properties data type contains the virus definition file version.", + "properties": { + "datVersion": { + "name": "datVersion", + "type": "string", + "form": "local", + "doc": "The virus definition file version." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version45_Agent_Details": { + "name": "McAfee_Epolicy_Orchestrator_Version45_Agent_Details", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version45_Agent_Details data type represents a virus scan agent and contains details about its version.", + "properties": { + "agentVersion": { + "name": "agentVersion", + "type": "string", + "form": "local", + "doc": "Version number of the anti-virus scan agent." + }, + "lastUpdate": { + "name": "lastUpdate", + "type": "dateTime", + "form": "local", + "doc": "The date of the last time the anti-virus agent checked in." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details": { + "name": "McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details data type contains the name of an anti-virus policy.", + "properties": { + "agentDetails": { + "name": "agentDetails", + "type": "McAfee_Epolicy_Orchestrator_Version45_Agent_Details", + "form": "relational", + "doc": "Additional information about an agent." + }, + "policies": { + "name": "policies", + "type": "McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details", + "form": "relational", + "typeArray": true, + "doc": "The current anti-virus policy of an agent." + }, + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name of a policy." + }, + "policyCount": { + "name": "policyCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the current anti-virus policy of an agent." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version45_Event": { + "name": "McAfee_Epolicy_Orchestrator_Version45_Event", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version45_Event data type represents a single event. It contains details about the event such as the date the event occurred, the virus or intrusion that is detected and the action that is taken. ", + "properties": { + "agentDetails": { + "name": "agentDetails", + "type": "McAfee_Epolicy_Orchestrator_Version45_Agent_Details", + "form": "relational", + "doc": "Additional information about an agent." + }, + "virusActionTaken": { + "name": "virusActionTaken", + "type": "McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description", + "form": "relational", + "doc": "The action taken when a virus is detected." + }, + "detectedUtc": { + "name": "detectedUtc", + "type": "dateTime", + "form": "local", + "doc": "The time that an event was detected." + }, + "sourceIpv4": { + "name": "sourceIpv4", + "type": "string", + "form": "local", + "doc": "The IP address of the source that generated an event." + }, + "sourceProcessName": { + "name": "sourceProcessName", + "type": "string", + "form": "local", + "doc": "The name of the process that generated an event." + }, + "targetFilename": { + "name": "targetFilename", + "type": "string", + "form": "local", + "doc": "The name of the file that was the target of the event." + }, + "threatActionTaken": { + "name": "threatActionTaken", + "type": "string", + "form": "local", + "doc": "The action taken regarding a threat." + }, + "threatName": { + "name": "threatName", + "type": "string", + "form": "local", + "doc": "The name of the threat." + }, + "threatSeverityLabel": { + "name": "threatSeverityLabel", + "type": "string", + "form": "local", + "doc": "The textual representation of the severity level." + }, + "threatType": { + "name": "threatType", + "type": "string", + "form": "local", + "doc": "The type of threat." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description": { + "name": "McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description data type contains the name of the rule that was triggered by an event.", + "properties": { + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name of the rule that triggered an event." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version45_Event_Version7": { + "name": "McAfee_Epolicy_Orchestrator_Version45_Event_Version7", + "base": "McAfee_Epolicy_Orchestrator_Version45_Event", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version45_Event_Version7 data type represents a single event. It contains details about the event such as the date the event occurred, the virus or intrusion that is detected and the action that is taken. ", + "properties": { + "signature": { + "name": "signature", + "type": "McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7", + "form": "relational", + "doc": "The signature information for an event." + }, + "agentDetails": { + "name": "agentDetails", + "type": "McAfee_Epolicy_Orchestrator_Version45_Agent_Details", + "form": "relational", + "doc": "Additional information about an agent." + }, + "virusActionTaken": { + "name": "virusActionTaken", + "type": "McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description", + "form": "relational", + "doc": "The action taken when a virus is detected." + }, + "detectedUtc": { + "name": "detectedUtc", + "type": "dateTime", + "form": "local", + "doc": "The time that an event was detected." + }, + "sourceIpv4": { + "name": "sourceIpv4", + "type": "string", + "form": "local", + "doc": "The IP address of the source that generated an event." + }, + "sourceProcessName": { + "name": "sourceProcessName", + "type": "string", + "form": "local", + "doc": "The name of the process that generated an event." + }, + "targetFilename": { + "name": "targetFilename", + "type": "string", + "form": "local", + "doc": "The name of the file that was the target of the event." + }, + "threatActionTaken": { + "name": "threatActionTaken", + "type": "string", + "form": "local", + "doc": "The action taken regarding a threat." + }, + "threatName": { + "name": "threatName", + "type": "string", + "form": "local", + "doc": "The name of the threat." + }, + "threatSeverityLabel": { + "name": "threatSeverityLabel", + "type": "string", + "form": "local", + "doc": "The textual representation of the severity level." + }, + "threatType": { + "name": "threatType", + "type": "string", + "form": "local", + "doc": "The type of threat." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version45_Event_Version8": { + "name": "McAfee_Epolicy_Orchestrator_Version45_Event_Version8", + "base": "McAfee_Epolicy_Orchestrator_Version45_Event", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version45_Event_Version8 data type represents a single event. It contains details about the event such as the date the event occurred, the virus or intrusion that is detected and the action that is taken. ", + "properties": { + "signature": { + "name": "signature", + "type": "McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8", + "form": "relational", + "doc": "The signature information for an event." + }, + "agentDetails": { + "name": "agentDetails", + "type": "McAfee_Epolicy_Orchestrator_Version45_Agent_Details", + "form": "relational", + "doc": "Additional information about an agent." + }, + "virusActionTaken": { + "name": "virusActionTaken", + "type": "McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description", + "form": "relational", + "doc": "The action taken when a virus is detected." + }, + "detectedUtc": { + "name": "detectedUtc", + "type": "dateTime", + "form": "local", + "doc": "The time that an event was detected." + }, + "sourceIpv4": { + "name": "sourceIpv4", + "type": "string", + "form": "local", + "doc": "The IP address of the source that generated an event." + }, + "sourceProcessName": { + "name": "sourceProcessName", + "type": "string", + "form": "local", + "doc": "The name of the process that generated an event." + }, + "targetFilename": { + "name": "targetFilename", + "type": "string", + "form": "local", + "doc": "The name of the file that was the target of the event." + }, + "threatActionTaken": { + "name": "threatActionTaken", + "type": "string", + "form": "local", + "doc": "The action taken regarding a threat." + }, + "threatName": { + "name": "threatName", + "type": "string", + "form": "local", + "doc": "The name of the threat." + }, + "threatSeverityLabel": { + "name": "threatSeverityLabel", + "type": "string", + "form": "local", + "doc": "The textual representation of the severity level." + }, + "threatType": { + "name": "threatType", + "type": "string", + "form": "local", + "doc": "The type of threat." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7": { + "name": "McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7 data type contains the signature name of a rule that generated an IPS event.", + "properties": { + "signatureName": { + "name": "signatureName", + "type": "string", + "form": "local", + "doc": "The name of a rule that triggered an IPS event." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8": { + "name": "McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8 data type contains the signature name of a rule that generated an IPS event.", + "properties": { + "signatureName": { + "name": "signatureName", + "type": "string", + "form": "local", + "doc": "The name of a rule that triggered an IPS event." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version45_Policy_Object": { + "name": "McAfee_Epolicy_Orchestrator_Version45_Policy_Object", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version45_Policy_Object data type contains the name of a policy that may be assigned to a server.", + "properties": { + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name of a policy." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version45_Product_Properties": { + "name": "McAfee_Epolicy_Orchestrator_Version45_Product_Properties", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version45_Product_Properties data type contains the virus definition file version.", + "properties": { + "datVersion": { + "name": "datVersion", + "type": "string", + "form": "local", + "doc": "The virus definition file version." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version51_Agent_Details": { + "name": "McAfee_Epolicy_Orchestrator_Version51_Agent_Details", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version51_Agent_Details data type represents a virus scan agent and contains details about its version.", + "properties": { + "agentVersion": { + "name": "agentVersion", + "type": "string", + "form": "local", + "doc": "Version number of the anti-virus scan agent." + }, + "lastUpdate": { + "name": "lastUpdate", + "type": "dateTime", + "form": "local", + "doc": "The date of the last time the anti-virus agent checked in." + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version51_Policy_Object": { + "name": "McAfee_Epolicy_Orchestrator_Version51_Policy_Object", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version51_Policy_Object data type represents a virus scan agent and contains details about its version.", + "properties": { + "name": { + "name": "name", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "McAfee_Epolicy_Orchestrator_Version51_Product_Properties": { + "name": "McAfee_Epolicy_Orchestrator_Version51_Product_Properties", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The McAfee_Epolicy_Orchestrator_Version51_Product_Properties data type represents the version of the virus data file", + "properties": { + "datVersion": { + "name": "datVersion", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Abuse_Lockdown_Resource": { + "name": "SoftLayer_Abuse_Lockdown_Resource", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational" + }, + "invoiceItem": { + "name": "invoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational" + } + }, + "methods": {} + }, + "SoftLayer_Account": { + "name": "SoftLayer_Account", + "base": "SoftLayer_Entity", + "serviceDoc": "Every SoftLayer customer has an account which is defined in the SoftLayer_Account service. SoftLayer accounts have users, hardware, and services such as storage and domains associated with them. The SoftLayer_Account service is a convenient way to obtain general information about your SoftLayer account. Use the data returned by these methods with other API services to get more detailed information about your services and to make changes to your servers and services. \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. ", + "methods": { + "activatePartner": { + "name": "activatePartner", + "type": "SoftLayer_Account", + "docOverview": "This service enables a partner account that has been created but is currently inactive. This restricted service is only available for certain accounts. Please contact support for questions. ", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "accountId", + "type": "string", + "doc": "Specify the account ID that needs to be activated." + }, + { + "name": "hashCode", + "type": "string", + "doc": "Specify the hashcode for the partner" + } + ] + }, + "addAchInformation": { + "name": "addAchInformation", + "type": "boolean", + "parameters": [ + { + "name": "achInformation", + "type": "SoftLayer_Container_Billing_Info_Ach", + "doc": "ACH Information for this account" + } + ], + "static": true + }, + "addReferralPartnerPaymentOption": { + "name": "addReferralPartnerPaymentOption", + "type": "boolean", + "parameters": [ + { + "name": "paymentOption", + "type": "SoftLayer_Container_Referral_Partner_Payment_Option", + "doc": "Referral Partner Payment Option for this account", + "defaultValue": null + } + ], + "static": true + }, + "areVdrUpdatesBlockedForBilling": { + "name": "areVdrUpdatesBlockedForBilling", + "type": "boolean", + "doc": "This method indicates whether or not Bandwidth Pooling updates are blocked for the account so the billing cycle can run. Generally, accounts are restricted from moving servers in or out of Bandwidth Pools from 12:00 CST on the day prior to billing, until the billing batch completes, sometime after midnight the day of actual billing for the account. ", + "docOverview": "This method returns true if Bandwidth Pooling updates are blocked so billing can run for this account.", + "static": true + }, + "cancelPayPalTransaction": { + "name": "cancelPayPalTransaction", + "type": "boolean", + "doc": "Cancel the PayPal Payment Request process. During the process of submitting a PayPal payment request, the customer is redirected to PayPal to confirm the request. If the customer elects to cancel the payment from PayPal, they are returned to SoftLayer where the manual payment record is updated to a status of canceled. ", + "docOverview": "Cancel the PayPal Payment Request process.", + "parameters": [ + { + "name": "token", + "type": "string", + "doc": "Value provided by PayPal to access paypal information and complete the transaction." + }, + { + "name": "payerId", + "type": "string", + "doc": "Paypal user identifier." + } + ], + "static": true + }, + "completePayPalTransaction": { + "name": "completePayPalTransaction", + "type": "string", + "doc": "Complete the PayPal Payment Request process and receive confirmation message. During the process of submitting a PayPal payment request, the customer is redirected to PayPal to confirm the request. Once confirmed, PayPal returns the customer to SoftLayer where an attempt is made to finalize the transaction. A status message regarding the attempt is returned to the calling function. ", + "docOverview": "Complete the PayPal Payment Request process and receive confirmation message.", + "parameters": [ + { + "name": "token", + "type": "string", + "doc": "Value provided by PayPal to access paypal information and complete the transaction." + }, + { + "name": "payerId", + "type": "string", + "doc": "Paypal user identifier." + } + ], + "static": true + }, + "countHourlyInstances": { + "name": "countHourlyInstances", + "type": "int", + "doc": "Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached. ", + "docOverview": "Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached. ", + "static": true + }, + "createUser": { + "name": "createUser", + "type": "SoftLayer_User_Customer", + "doc": "Create a new Customer user record in the SoftLayer customer portal. This is a wrapper around the Customer::createObject call, please see the documentation of that API. This wrapper adds the feature of the \"silentlyCreate\" option, which bypasses the IBMid invitation email process. False (the default) goes through the IBMid invitation email process, which creates the IBMid/SoftLayer Single-Sign-On (SSO) user link when the invitation is accepted (meaning the email has been received, opened, and the link(s) inside the email have been clicked to complete the process). True will silently (no email) create the IBMid/SoftLayer user SSO link immediately. Either case will use the value in the template object 'email' field to indicate the IBMid to use. This can be the username or, if unique, the email address of an IBMid. In the silent case, the IBMid must already exist. In the non-silent invitation email case, the IBMid can be created during this flow, by specifying an email address to be used to create the IBMid.All the features and restrictions of createObject apply to this API as well. In addition, note that the \"silentlyCreate\" flag is ONLY valid for IBMid-authenticated accounts. ", + "docOverview": "Create a new user record, optionally skipping the IBMid email (\"silently\").", + "maskable": true, + "parameters": [ + { + "name": "templateObject", + "type": "SoftLayer_User_Customer", + "doc": "as documented by createObject" + }, + { + "name": "password", + "type": "string", + "doc": "as documented by createObject", + "defaultValue": null + }, + { + "name": "vpnPassword", + "type": "string", + "doc": "as documented by createObject", + "defaultValue": null + }, + { + "name": "silentlyCreateFlag", + "type": "boolean", + "doc": "- A flag to tell whether to go through the usual IBMid invitation email", + "defaultValue": false + } + ], + "static": true + }, + "disableEuSupport": { + "name": "disableEuSupport", + "type": "void", + "doc": "

Warning: 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
  • email
  • officePhone
  • alternatePhone
  • faxPhone
  • abuseEmails.email
  • billingInfo.vatId
", + "docOverview": "Edit an account's information.", + "docErrorHandling": [ + { + "exception": "", + "description": "SoftLayer_Exception_Public_Validation" + } + ], + "parameters": [ + { + "name": "modifiedAccountInformation", + "type": "SoftLayer_Account", + "doc": "Account template containing the information to update to." + } + ], + "static": true + }, + "enableEuSupport": { + "name": "enableEuSupport", + "type": "void", + "doc": "

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\n

Important 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\n

If 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": "<