Resource URL: /platform/<<version=4>>/cloud/proxies

    Overview: This resource applies the standard collection pattern to proxies.

     Methods: GET, POST

********************************************************************************

Method GET: List all proxies.

       URL: GET /platform/<<version=4>>/cloud/proxies

Query arguments:
  sort=<string> The field that will be used for sorting.
limit=<integer> Return no more than this many results at once (see resume).
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "proxies": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "The configuration settings for a network proxy", 
            "properties": {
              "username": {
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "The username to connect to this proxy if required"
              }, 
              "name": {
                "type": "string", 
                "description": "A unique friendly name for this proxy configuration"
              }, 
              "type": {
                "enum": [
                  "socks_4", 
                  "socks_5", 
                  "http"
                ], 
                "type": "string", 
                "description": "The type of connection used to connect to this proxy"
              }, 
              "id": {
                "type": "string", 
                "description": "A globally unique ID (guid) or the name of this proxy (read-only)"
              }, 
              "host": {
                "type": "string", 
                "description": "A host name or network address for connecting to this proxy"
              }, 
              "password": {
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "The password to connect to this proxy if required (write-only)"
              }, 
              "password_is_set": {
                "type": "boolean", 
                "description": "Indicates whether a password has been set for this proxy"
              }, 
              "port": {
                "type": "integer", 
                "description": "The port used to connect to this proxy"
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}

********************************************************************************

Method POST: Create a new proxy.

        URL: POST /platform/<<version=4>>/cloud/proxies

There are no query arguments for this method.

Required POST request body fields:
name, host, type, port

POST request body schema:
{
  "type": "object", 
  "description": "The configuration settings for a network proxy", 
  "properties": {
    "username": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "The username to connect to this proxy if required"
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "A unique friendly name for this proxy configuration"
    }, 
    "host": {
      "required": true, 
      "type": "string", 
      "description": "A host name or network address for connecting to this proxy"
    }, 
    "password": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "The password to connect to this proxy if required (write-only)"
    }, 
    "type": {
      "enum": [
        "socks_4", 
        "socks_5", 
        "http"
      ], 
      "type": "string", 
      "description": "The type of connection used to connect to this proxy", 
      "required": true
    }, 
    "port": {
      "required": true, 
      "type": "integer", 
      "description": "The port used to connect to this proxy"
    }
  }
}

POST response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "id": {
          "type": "string", 
          "description": "The globally unique ID (guid) of the new proxy"
        }
      }
    }
  ]
}
