• Network Access Manager

nwtargets

PrivX Network Targets

get/network-access-manager/api/v1/nwtargets

List network targets

Get all network targets

offsetint

Collection query offset

Default
0
Min
0
limitint

Maximum number of collection items to return

Default
50
sortkeystring

Sorting key

Default
"id"
Enum
  • id
  • name
  • comment
  • user_instructions
  • exclusive_access
  • disabled
  • created
  • updated
sortdirstring

Sorting direction

Default
"ASC"
Enum
  • ASC
  • DESC
namestring

The name of the network target

idstring

The ID of the network target

Format
uuid

Responses

Response examples

Authentication succesful

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "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",
          "deleted": true
        }
      ],
      "integration_type": "",
      "static_config": "string",
      "dst": [
        {
          "selector": {
            "ip": {
              "start": "string",
              "end": "string"
            },
            "port": {
              "start": 1,
              "end": 1
            },
            "proto": ""
          },
          "nat": {
            "addr": "string",
            "port": 0
          }
        }
      ],
      "exclusive_access": true,
      "disabled": "FALSE",
      "tags": [
        "string"
      ]
    }
  ]
}
post/network-access-manager/api/v1/nwtargets

Create a network target

Create a network target

idstring

A unique identifier for the user

Format
uuid
createdstring

When the object was created

Format
date-time
Example
"2017-01-01T15:05:05Z"
updatedstring

When the object was updated

Format
date-time
Example
"2017-01-01T15:05:05Z"
updated_bystring

ID of the user who updated the object

Format
uuid
Example
"eef4aefc-d64e-4c2c-aba4-4914c86ce059"
authorstring

ID of the user who originally authored the object

Format
uuid
Example
"eef4aefc-d64e-4c2c-aba4-4914c86ce059"
commentstring

A comment describing the object

Max Length
1024
Example
"A comment"
namestring

required

A unique name for the network target

Max Length
1024
user_instructionsstring

User instructions shown in UI

Max Length
1024
src_natboolean

Flag to enable source NATing

rolesarray

required

idstring

required

Role ID

namestring

Role name, ignored by server in requests.

integration_typestring

Router integration type

Default
""
Enum
  • GENERIC
  • NQX
static_configstring

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

Max Length
10240
dstarray

required

selectorobject (selector)

required

Selector specifies a single network target destination

natobject (nat)

NAT destination parameters

exclusive_accessboolean

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

disabledstring

Network target disabled status

Enum
  • FALSE
  • BY_ADMIN
tagsarray

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

Max Length
1024

Responses

Request examples

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "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": 1,
          "end": 1
        },
        "proto": ""
      },
      "nat": {
        "addr": "string",
        "port": 0
      }
    }
  ],
  "exclusive_access": true,
  "disabled": "FALSE",
  "tags": [
    "string"
  ]
}

Response examples

Network target successfully created

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}
post/network-access-manager/api/v1/nwtargets/search

Find network targets

Find network targets

keywordsstring

comma or space separated list of search keywords

tagsarray

tags to search, network target tags will be searched using case-insensitive exact matching

Responses

Request examples

{
  "keywords": "string",
  "tags": [
    "string"
  ]
}

Response examples

Network target search succeeded

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "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",
          "deleted": true
        }
      ],
      "integration_type": "",
      "static_config": "string",
      "dst": [
        {
          "selector": {
            "ip": {
              "start": "string",
              "end": "string"
            },
            "port": {
              "start": 1,
              "end": 1
            },
            "proto": ""
          },
          "nat": {
            "addr": "string",
            "port": 0
          }
        }
      ],
      "exclusive_access": true,
      "disabled": "FALSE",
      "tags": [
        "string"
      ]
    }
  ]
}
get/network-access-manager/api/v1/nwtargets/tags

List network target tags

Get all of network targets' tags.

offsetint

Collection query offset

Default
0
Min
0
limitint

Maximum number of collection items to return

Default
50
sortdirstring

Sorting direction

Default
"ASC"
Enum
  • ASC
  • DESC
querystring

Query string matches the tags

Responses

Response examples

Successfully returned network targets' tags

{
  "count": 123,
  "items": [
    "string"
  ]
}
get/network-access-manager/api/v1/nwtargets/{id}

Get a network target

Get a network target by ID

idstring

required

Network Target ID

Format
uuid

Responses

Response examples

Successful response, returns a user object

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "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",
      "deleted": true
    }
  ],
  "integration_type": "",
  "static_config": "string",
  "dst": [
    {
      "selector": {
        "ip": {
          "start": "string",
          "end": "string"
        },
        "port": {
          "start": 1,
          "end": 1
        },
        "proto": ""
      },
      "nat": {
        "addr": "string",
        "port": 0
      }
    }
  ],
  "exclusive_access": true,
  "disabled": "FALSE",
  "tags": [
    "string"
  ]
}
put/network-access-manager/api/v1/nwtargets/{id}

Update a network target

Update a network target by ID

idstring

A unique identifier for the user

Format
uuid
createdstring

When the object was created

Format
date-time
Example
"2017-01-01T15:05:05Z"
updatedstring

When the object was updated

Format
date-time
Example
"2017-01-01T15:05:05Z"
updated_bystring

ID of the user who updated the object

Format
uuid
Example
"eef4aefc-d64e-4c2c-aba4-4914c86ce059"
authorstring

ID of the user who originally authored the object

Format
uuid
Example
"eef4aefc-d64e-4c2c-aba4-4914c86ce059"
commentstring

A comment describing the object

Max Length
1024
Example
"A comment"
namestring

required

A unique name for the network target

Max Length
1024
user_instructionsstring

User instructions shown in UI

Max Length
1024
src_natboolean

Flag to enable source NATing

rolesarray

required

idstring

required

Role ID

namestring

Role name, ignored by server in requests.

integration_typestring

Router integration type

Default
""
Enum
  • GENERIC
  • NQX
static_configstring

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

Max Length
10240
dstarray

required

selectorobject (selector)

required

Selector specifies a single network target destination

natobject (nat)

NAT destination parameters

exclusive_accessboolean

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

disabledstring

Network target disabled status

Enum
  • FALSE
  • BY_ADMIN
tagsarray

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

Max Length
1024

Responses

Request examples

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "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": 1,
          "end": 1
        },
        "proto": ""
      },
      "nat": {
        "addr": "string",
        "port": 0
      }
    }
  ],
  "exclusive_access": true,
  "disabled": "FALSE",
  "tags": [
    "string"
  ]
}

Response examples

Network target successfully updated

Empty response

delete/network-access-manager/api/v1/nwtargets/{id}

Delete a network target

Delete a network target by ID

idstring

required

Network target ID

Format
uuid

Responses

Response examples

Network target successfully deleted

Empty response

put/network-access-manager/api/v1/nwtargets/{id}/disabled

Disable a network target

Disable a network target by ID

disabledboolean

disabled flag: true/false

Responses

Request examples

{
  "disabled": true
}

Response examples

Successful response

Empty response

Was this page helpful?