NSX-T Data Center REST API

ServiceManager (type)

{
  "description": "Partner console endpoint information for enabling NSX to callback with events and status.",
  "extends": {
    "$ref": "ManagedResource"
  },
  "id": "ServiceManager",
  "module_id": "ServiceInsertionCommonTypes",
  "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"
    },
    "authentication_scheme": {
      "$ref": "CallbackAuthenticationScheme",
      "description": "A CallbackAuthenticationScheme that describes how notification requests/callbacks from NSX, should authenticate to the server.",
      "readonly": false,
      "required": true,
      "title": "Scheme to authenticate requests sent to the server"
    },
    "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"
    },
    "id": {
      "can_sort": true,
      "title": "Unique identifier of this resource",
      "type": "string"
    },
    "port": {
      "description": "Integer port value to specify a standard/non-standard HTTPS port.",
      "maximum": 65535,
      "minimum": 0,
      "readonly": false,
      "required": true,
      "title": "Integer port value to specify a HTTPS port",
      "type": "integer"
    },
    "resource_type": {
      "description": "The type of this resource.",
      "readonly": false,
      "type": "string"
    },
    "server": {
      "description": "IP address or fully qualified domain name of the partner REST server.",
      "readonly": false,
      "required": true,
      "title": "IP address or fully qualified domain name of server",
      "type": "string"
    },
    "service_ids": {
      "description": "The IDs of services, provided by partner.",
      "items": {
        "$ref": "ResourceReference"
      },
      "readonly": false,
      "required": true,
      "title": "Service IDs",
      "type": "array"
    },
    "tags": {
      "items": {
        "$ref": "Tag"
      },
      "maxItems": 30,
      "title": "Opaque identifiers meaningful to the API user",
      "type": "array"
    },
    "thumbprint": {
      "description": "Thumbprint (SHA-256 hash represented in lower case hex) for the certificate on the partner console. This will be required to establish secure communication with the console and to avoid man-in-the-middle attacks.",
      "title": "Thumbprint of the certificate for partner console",
      "type": "string"
    },
    "uri": {
      "description": "URI on which notification requests should be made on the specified server.",
      "readonly": false,
      "required": true,
      "title": "URI notification requests should be made on the server",
      "type": "string"
    },
    "vendor_id": {
      "description": "Id which is unique to a vendor or partner for which the service is created.",
      "readonly": true,
      "required": false,
      "title": "Vendor ID",
      "type": "string"
    }
  },
  "title": "Definition of a Service Manager",
  "type": "object"
}