NSX-T Data Center REST API

Proxy (type)

{
  "description": "Type to define the Proxy configuration.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "Proxy", 
  "module_id": "ProxyConfig", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "computed": true, 
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "certificate_id": {
      "description": "Certificate ID with a valid certificate, procured from trust-management API. If the scheme property is set to HTTPS, certificate_id is verified if specified.", 
      "required": false, 
      "title": "Valid certificate ID", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "computed": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "description": "Flag to indicate if proxy is enabled. When set to true, a scheme, host and port must be provided.", 
      "required": true, 
      "title": "Flag to indicate if proxy is enabled.", 
      "type": "boolean"
    }, 
    "host": {
      "description": "Specify the fully qualified domain name, or ip address, of the proxy server.", 
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "FQDN or IP address of the proxy server", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "password": {
      "description": "Specify the password used to authenticate with the proxy server, if required.", 
      "required": false, 
      "sensitive": true, 
      "title": "Password", 
      "type": "secure_string"
    }, 
    "port": {
      "description": "Specify the port of the proxy server.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": true, 
      "title": "Configured port for proxy", 
      "type": "int"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "scheme": {
      "description": "The scheme accepted by the proxy server. Specify one of HTTP and HTTPS.", 
      "enum": [
        "HTTP", 
        "HTTPS"
      ], 
      "required": true, 
      "title": "The scheme accepted by the proxy server", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "test_connection_url": {
      "default": "https://www.vmware.com", 
      "description": "Specify a url for connection testing when adding proxy config. https://www.vmware.com is used by default if not specified.", 
      "required": false, 
      "title": "Test connection url", 
      "type": "string"
    }, 
    "username": {
      "description": "Specify the user name used to authenticate with the proxy server, if required.", 
      "required": false, 
      "title": "User name", 
      "type": "string"
    }
  }, 
  "title": "Proxy Configuration", 
  "type": "object"
}