nwtarget

A complete network target object

idstring<uuid>

A unique identifier for the user

createdstring<date-time>

When the object was created

Example: 2017-01-01T15:05:05Z

updatedstring<date-time>

When the object was updated

Example: 2017-01-01T15:05:05Z

updated_bystring<uuid>

ID of the user who updated the object

Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059

authorstring<uuid>

ID of the user who originally authored the object

Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059

commentstring

A comment describing the object

Possible values: <= 1024 characters

Example: A comment

namestringrequired

A unique name for the network target

Possible values: <= 1024 characters

user_instructionsstring

User instructions shown in UI

Possible values: <= 1024 characters

src_natboolean

Flag to enable source NATing

roles object[]required

Array [

idstringrequired

Role ID

namestring

Role name, ignored by server in requests.

]

integration_typestring

Router integration type

Possible values: [``, GENERIC, NQX]

Default value:

static_configstring

Static network target configuration used for router integration, formatted as a string-serialized JSON object

Possible values: <= 10240 characters

dst object[]required

Array [

selector objectrequired

Selector specifies a single network target destination

ip objectrequired

IP address range from start(inclusive) to end(inclusive)

startstringrequired

Singe IPv4/IPv6 address

endstringrequired

Single IPv4/IPv6 address

port object

port specifies port range from start(inclusive) to end(inclusive)

startintegerrequired

start port number range from 1-65535

Possible values: >= 1 and <= 65535

endintegerrequired

end port number range from 1-65535

Possible values: >= 1 and <= 65535

protostring

allowed IP protocol, including no protocol

Possible values: [``, udp, tcp]

nat object

NAT destination parameters

addrstringrequired

destination address

portinteger

port number

Possible values: >= 0 and <= 65535

]

exclusive_accessboolean

Allow only one ongoing network access session at a time to this network target.

disabledstring

Network target disabled status

Possible values: [FALSE, BY_ADMIN]

tagsstring[]

Tags. Maximum allowed number of tags is 128 and each tag must be no longer than 1024 characters.

Possible values: <= 128

nwtarget

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "comment": "A comment",
  "name": "string",
  "user_instructions": "string",
  "src_nat": true,
  "roles": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "integration_type": "",
  "static_config": "string",
  "dst": [
    {
      "selector": {
        "ip": {
          "start": "string",
          "end": "string"
        },
        "port": {
          "start": 0,
          "end": 0
        },
        "proto": ""
      },
      "nat": {
        "addr": "string",
        "port": 0
      }
    }
  ],
  "exclusive_access": true,
  "disabled": "FALSE",
  "tags": [
    "string"
  ]
}