Get SASE Connection Statuses (v2.0)

POST 
/sdwan/v2.0/api/prismasase_connections/status/query

Get a list of SASE connection statuses.

Request

application/json

Body

aggregate Aggregate

The aggregate number of sase connections that match the query parameters.

data AggregateData[]

The details of the aggregate data.

Array [

value number

Value of the aggregate data.

view object

View the aggregate date.

]

field string

The field value.

name string

The name of the query response.

operator string

Possible values: [max, count, min, avg, sum]

The operator values.

statistic string

The aggregate statistics.

unit string

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number sase connections deleted for a time frame.

group_by string[]

Group the sase connections for the query.

id string

List the sase connections by ID.

last_query_ts int64

Return the ID of a specified query in the current session.

limit int32required

The query limit.

next_query object

The limit.

query_params object

Query using query parameters.

retrieved_fields string[]

Retrieve information from a field.

retrieved_fields_mask boolean

List the fields to query.

sort_params object

Specify the order in which you want the search criteria to display.

total_count int64

The total number of query parameters.

Responses

200

Successful Operation

application/json

Schema

Schema

common_messages string

Common messages.

connection_status PrismaConnectionStatus

The prisma connection status.

value string

Value

id string

List the sase connections by ID.

ipsec_tunnel_status IPSecTunnelStatus[]
The IPSec tunnel status information.
Array [
attempts int32
The number of connectivity attempts.
branch_tunnel_connection_status string
The branch tunnel connection status.
branch_tunnel_provisioning_status string
The branch tunnel provisioning status.
completed_steps string[]
The completed steps of tunnel creation.
element_id string
The element ID.
error_messages object
Any error messages during connectivity.
info_messages object
Any info messages during connectivity.
interface_id string
The interface ID.
name string
Name
prismaaccess_tunnel_connection_status string
The prisma access tunnel connection status.
prismaaccess_tunnel_provisioning_status string
The prisma access tunnel provisioning status.
remoteNetworkGroupName string
The remote network group name.
uncompleted_steps string[]
The incomplete steps of tunnel creation.
]
is_active boolean

The active RP for the sase connection.

prismasase_connection_id string

The prisma sase connection ID.

site_id stringrequired

The site ID.

Example (from schema)

{
  "common_messages": "string",
  "connection_status": {
    "value": "string"
  },
  "id": "string",
  "ipsec_tunnel_status": [
    {
      "attempts": 0,
      "branch_tunnel_connection_status": "string",
      "branch_tunnel_provisioning_status": "string",
      "completed_steps": [
        "string"
      ],
      "element_id": "string",
      "error_messages": {},
      "info_messages": {},
      "interface_id": "string",
      "name": "string",
      "prismaaccess_tunnel_connection_status": "string",
      "prismaaccess_tunnel_provisioning_status": "string",
      "remoteNetworkGroupName": "string",
      "uncompleted_steps": [
        "string"
      ]
    }
  ],
  "is_active": true,
  "prismasase_connection_id": "string",
  "site_id": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "QUERY_PARAMS_REQUIRED"
      },
      {
        "code": "SITE_IDS_REQUIRED"
      },
      {
        "code": "SITES_NUMBER_INVALID"
      },
      {
        "code": "INVALID_LIMIT_NUMBER"
      }
    ]
  }
}

404

Resource Not Found

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Loading...