Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

JSA Network Insights Endpoints

 

Use the references for REST API V9.0 JSA Network Insights endpoints.

GET /qni/hosts/{host_id}/configs

Gets the list of QNI Port Configurations. List contains a single configuration.

Table 1: GET /qni/hosts/{host_id}/configs Resource Details

MIME Type

application/json

Table 2: GET /qni/hosts/{host_id}/configs Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

host_id

path

Required

Number (Integer)

text/plain

Long The ID of the QNI host.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3: GET /qni/hosts/{host_id}/configs Response Codes

HTTP Response Code

Unique Code

Description

200

 

QNI port configuration has been successfully retrieved.

404

44001

QNI host id does not exist.

422

44020

QNI host id is less than or equal to 0.

500

44010

An internal server error occurred while processing a request.

Response Description

An array containing a single QNI Port Configuration object. This is the current port configuration of a QNI host.

  • id - Number - ID of the QNI configuration. Always equals 1 because QNI host has only one configuration.

  • host_id - Number - ID of the QNI host.

  • ports - Array - Array of configured network card ports. Each port has the following fields:

    • port_id - Number - ID of the port.

    • type - Enumeration - Mode the port is used in. The possible values are RECEIVE, TRANSMIT. RECEIVE type indicates the port is configured to receive traffic. TRANSMIT type indicates the port is transmitting traffic duplicated from another port.

    • source_port_id - Number - ID of the port the traffic is retransmitted from. Only populated if port type is TRANSMIT.

Response Sample

[ { "host_id": 42, "id": 42, "ports": [ { "id": 42, "source_port_id": 42, "type": "String <one of: RECEIVE, TRANSMIT>" } ] } ]

POST /qni/hosts/{host_id}/configs/{id}

Updates a QNI Port Configuration by id. Port configuration should contain the following fields:

  • id - Required - Number - ID of the QNI configuration. Always equals 1 because QNI host has only one configuration.

  • host_id - Required - Number - ID of the QNI host.

  • ports - Required - Array - The updated configuration of ports. Each port has the following fields:

    • port_id - Required - Number - ID of the port.

    • type - Required - Enumeration - Mode the port is used in. The possible values are RECEIVE, TRANSMIT.

    • source_port_id - Optional - Number - ID of the port traffic is retransmitted from. Required only if port type is TRANSMIT.

Table 4: POST /qni/hosts/{host_id}/configs/{id} Resource Details

MIME Type

application/json

Table 5: POST /qni/hosts/{host_id}/configs/{id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

host_id

path

Required

Number (Integer)

text/plain

Long The ID of the QNI host.

id

path

Required

Number (Integer)

text/plain

The ID of the QNI port configuration.

fields

header

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 6: POST /qni/hosts/{host_id}/configs/{id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

qni_port_configuration

Object

application/json

The updated QNI Port Configuration (see above for more details).

{ "host_id": 42, "id": 42, "ports": [ { "id": 42, "source_port_id": 42, "type": "String <one of: RECEIVE, TRANSMIT>" } ] }

Table 7: POST /qni/hosts/{host_id}/configs/{id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

QNI port configuration has been successfully updated.

404

44101

QNI host id does not exist.

404

44102

QNI Port Configuration id does not exist.

422

44120

QNI host id is less than or equal to 0.

422

44121

Ports array is missing.

422

44122

Invalid number of ports listed.

422

44123

Port id field is missing.

422

44124

Port id is invalid.

422

44125

Two or more ports have the same id.

422

44126

Source port id field is missing.

422

44127

Source port id is invalid.

422

44128

Source port is invalid. Selected source port has to have RECEIVE type.

422

44129

Port type is invalid.

422

44130

QNI host is a part of QNI Stack. Port configuration of this host cannot be changed individually.

500

44110

An internal server error occurred while processing a request.

Response Description

An updated QNI Port Configuration object representing a staged port configuration of a QNI host.

  • id - Number - ID of the QNI configuration. Always equals 1 because QNI host has only one configuration.

  • host_id - Number - ID of the QNI host.

  • ports - Array - Array of configured network card ports. Each port has the following fields:

    • port_id - Number - ID of the port.

    • type - Enumeration - Mode the port is used in. The possible values are RECEIVE, TRANSMIT. RECEIVE type indicates the port is configured to receive traffic. TRANSMIT type indicates the port is transmitting traffic duplicated from another port.

    • source_port_id - Number - ID of the port the traffic is retransmitted from. Only populated if port type is TRANSMIT.

Response Sample

{ "host_id": 42, "id": 42, "ports": [ { "id": 42, "source_port_id": 42, "type": "String <one of: RECEIVE, TRANSMIT>" } ] }

GET /qni/stacking/stacks

Retrieve list of all QNI stacks in the system.

Table 8: GET /qni/stacking/stacks Resource Details

MIME Type

application/json

Table 9: GET /qni/stacking/stacks Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

Table 10: GET /qni/stacking/stacks Response Codes

HTTP Response Code

Unique Code

Description

200

 

The requested list of QNI stacks have been retrieved.

403

1009

You do not have the required capabilities to retrieve data for QNI stacks.

404

1002

No QNI stacks found.

500

1020

An error occurred attempting to retrieve data for QNI stacks.

Response Description

List of QNI stacks. A stack contains the following fields:

  • stack_id - Long - ID of the QNI stack.

  • hosts - List<Host> - List of QNI managed hosts in the stack.

  • name - String - Name of the QNI stack.

  • ports_type - enum - Port configuration type for the QNI stack.

Response Sample

[ { "hosts": [ { "host_id": 42, "host_ip": "String", "primary": true } ], "name": "String", "ports_type": "String <one of: IN_4, IN_2_OUT_2, IN_1_OUT_1, IN_1_OUT_3, IN_3_OUT_1>", "stack_id": 42 } ]

POST /qni/stacking/stacks

Create a QNI stack.

Table 11: POST /qni/stacking/stacks Resource Details

MIME Type

application/json

Table 12: POST /qni/stacking/stacks Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

fields

header

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 13: POST /qni/stacking/stacks Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

stack

Object

application/json

null

{ "hosts": [ { "host_id": 42, "host_ip": "String", "primary": true } ], "name": "String", "ports_type": "String <one of: IN_4, IN_2_OUT_2, IN_1_OUT_1, IN_1_OUT_3, IN_3_OUT_1>", "stack_id": 42 }

Table 14: POST /qni/stacking/stacks Response Codes

HTTP Response Code

Unique Code

Description

201

 

The QNI stack has been created.

403

1009

You do not have the required capabilities to create QNI stacks.

404

1002

QNI host not found.

422

1005

Invalid parameter value in JSON data.

500

1020

An error occurred attempting to create QNI stack.

Response Description

QNI stack. A stack contains the following fields:

  • stack_id - Long - ID of the QNI stack.

  • hosts - List<Host> - List of QNI managed hosts in the stack.

  • name - String - Name of the QNI stack..

  • ports_type - enum - Port configuration type for the QNI stack.

Response Sample

{ "hosts": [ { "host_id": 42, "host_ip": "String", "primary": true } ], "name": "String", "ports_type": "String <one of: IN_4, IN_2_OUT_2, IN_1_OUT_1, IN_1_OUT_3, IN_3_OUT_1>", "stack_id": 42 }

DELETE /qni/stacking/stacks/{stack_id}

Delete a QNI stack by ID.

Table 15: DELETE /qni/stacking/stacks/{stack_id} Resource Details

MIME Type

text/plain

Table 16: DELETE /qni/stacking/stacks/{stack_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

stack_id

path

Required

Number (Integer)

text/plain

null

Table 17: DELETE /qni/stacking/stacks/{stack_id} Response Codes

HTTP Response Code

Unique Code

Description

204

 

The QNI stack has been deleted.

403

1009

You do not have the required capabilities to retrieve QNI stacks.

404

1002

QNI stack not found.

500

1020

An error occurred attempting to retrieve QNI stack.

Response Description

Response Sample

GET /qni/stacking/stacks/{stack_id}

Retrieve a QNI stack by ID.

Table 18: GET /qni/stacking/stacks/{stack_id} Resource Details

MIME Type

application/json

Table 19: GET /qni/stacking/stacks/{stack_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

stack_id

path

Required

Number (Integer)

text/plain

null

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 20: GET /qni/stacking/stacks/{stack_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The requested QNI stack has been retrieved.

403

1009

You do not have the required capabilities to retrieve QNI stacks.

404

1002

QNI stack not found.

500

1020

An error occurred attempting to retrieve QNI stack.

Response Description

QNI stack. A stack contains the following fields:

  • stack_id - Long - ID of the QNI stack.

  • hosts - List<Host> - List of QNI managed hosts in the stack.

  • name - String - Name of the QNI stack.

  • ports_type - enum - Port configuration type for the QNI stack.

Response Sample

{ "hosts": [ { "host_id": 42, "host_ip": "String", "primary": true } ], "name": "String", "ports_type": "String <one of: IN_4, IN_2_OUT_2, IN_1_OUT_1, IN_1_OUT_3, IN_3_OUT_1>", "stack_id": 42 }

POST /qni/stacking/stacks/{stack_id}

Update a QNI stack by ID.

Table 21: POST /qni/stacking/stacks/{stack_id} Resource Details

MIME Type

application/json

Table 22: POST /qni/stacking/stacks/{stack_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

stack_id

path

Required

Number (Integer)

text/plain

null

fields

header

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 23: POST /qni/stacking/stacks/{stack_id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

stack

Object

application/json

null

{ "hosts": [ { "host_id": 42, "host_ip": "String", "primary": true } ], "name": "String", "ports_type": "String <one of: IN_4, IN_2_OUT_2, IN_1_OUT_1, IN_1_OUT_3, IN_3_OUT_1>", "stack_id": 42 }

Table 24: POST /qni/stacking/stacks/{stack_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The QNI stack has been updated.

403

1009

You do not have the required capabilities to retrieve QNI stacks.

404

1002

QNI stack not found.

422

1005

Invalid parameter value in JSON data.

500

1020

An error occurred attempting to retrieve QNI stack.

Response Description

QNI stack. A stack contains the following fields:

  • stack_id - Long - ID of the QNI stack.

  • hosts - List<Host> - List of QNI managed hosts in the stack.

  • name - String - Name of the QNI stack.

  • ports_type - enum - Port configuration type for the QNI stack.

Response Sample

{ "hosts": [ { "host_id": 42, "host_ip": "String", "primary": true } ], "name": "String", "ports_type": "String <one of: IN_4, IN_2_OUT_2, IN_1_OUT_1, IN_1_OUT_3, IN_3_OUT_1>", "stack_id": 42 }

GET /qni/stacking/standalone_hosts

Retrieve list of all QNI hosts not in stacks.

Table 25: GET /qni/stacking/standalone_hosts Resource Details

MIME Type

application/json

Table 26: GET /qni/stacking/standalone_hosts Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

Table 27: GET /qni/stacking/standalone_hosts Response Codes

HTTP Response Code

Unique Code

Description

200

 

QNI hosts were successfully retrieved.

403

1009

You do not have the required capabilities to retrieve data for QNI hosts.

404

1002

No standalone QNI hosts found.

500

1020

An error occurred attempting to retrieve data for QNI hosts.

Response Description

A list of QNI hosts. A host contains the following fields:

  • host_id - Long - ID of the QNI host.

  • host_ip - List<Host> - IP address of the QNI host.

  • primary - Boolean - Flag indicating QNI host as Stack primary (always false for standalone hosts).

Response Sample

[ { "host_id": 42, "host_ip": "String", "primary": true } ]