extenderlisteners

Download Spec

PrivX Extender Connection Listeners
get /extender-service/api/v1/listeners

Get extender listeners

offset

int

Offset from which to start fetching objects

Default
0

limit

int

Maximum number of objects to return

Default
50

sortkey

string

Sorting key

Default
"id"
Enum
  • id
  • network
  • destination
  • source
  • address
  • created
  • updated

sortdir

string

Sorting direction

Default
"ASC"
Enum
  • ASC
  • DESC

Response

ExamplesSchema

Request succesful

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "network": "string",
      "address": "string",
      "destination": "string",
      "source": [
        "string"
      ],
      "closed_in_sec": 123,
      "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"
    }
  ]
}

post /extender-service/api/v1/listeners

Create extender connection listener

network

string

required

Listener network, specifies the transport protocol for address, destination and source restrictions.

destination

string

required

Destination address including extender prefix, hostname and port

source

array[string]

Optional array of source IP addresses, CIDRs or hostnames that are allowed to connect to the listener, if empty connections are allowed from any source.

keep_open_sec

int

Number of seconds to keep the listener and all ongoing connections open.

Request

{
  "network": "string",
  "destination": "string",
  "source": [
    "string"
  ],
  "keep_open_sec": 123
}

Response

ExamplesSchema

Extender connection listener successfully created

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "network": "string",
  "address": "string",
  "destination": "string",
  "source": [
    "string"
  ],
  "closed_in_sec": 123,
  "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"
}

get /extender-service/api/v1/listeners/{id}

id

string

uuid

required

Extender connection listener ID

Response

ExamplesSchema

Successful response, returns a listener object

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "network": "string",
  "address": "string",
  "destination": "string",
  "source": [
    "string"
  ],
  "closed_in_sec": 123,
  "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"
}

put /extender-service/api/v1/listeners/{id}

Update an extender connection listener

id

string

uuid

A unique identifier for the listener

network

string

Listener network, specifies the transport protocol for address, destination and source restrictions.

address

string

Listener address as IP:port.

destination

string

Destination address including extender prefix, hostname and port

source

array[string]

Optional array of source IP addresses, CIDRs or hostnames that are allowed to connect to the listener, if empty connections are allowed from any source.

closed_in_sec

int

Number of seconds until the listener and all ongoing connections will be closed automatically unless a keep open request is sent before that.

created

string

date-time

When the object was created

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

updated

string

date-time

When the object was updated

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

updated_by

string

uuid

ID of the service who updated the object

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

author

string

uuid

ID of the service who originally authored the object

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

Request

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "network": "string",
  "address": "string",
  "destination": "string",
  "source": [
    "string"
  ],
  "closed_in_sec": 123,
  "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"
}

Response

ExamplesSchema

Extender connection listener successfully updated

Empty response

delete /extender-service/api/v1/listeners/{id}

Delete an extender connection listener

id

string

uuid

required

Extender connection listener ID

Response

ExamplesSchema

Extender connection listener successfully deleted

Empty response

Was this page helpful?