REST APIs for 24.2.20 and 24.2.10

org_id

Organization ID

Integer

Yes

activation_type

The method by which the VEN was activated

String

No

active_pce_fqdn

FQDN of the PCE

String

No

activation_recovery

Return VENs in or not in authentication recovery.

Boolean

No

condition

A specific error condition to filter by

String

No

container_clusters

The array of container cluster URIs, encoded as a JSON string

Object

No

disconnected_before

Return VENs that have been disconnected since the given time.

date/time

No

health

The overall health (condition) of the VEN

String

No

hostname

The hostname of VEN(s) to return. Supports partial matches.

String

No

ip_addressl

IP address of VEN(s) to return. Supports partial matches

String

No

last_goodbye_at

The time (rfc3339 timestamp) of the last goodbye from the VEN.

String, Null

os_platform

OS platform of the host managed by the VEN

String, Null

version

Software version of the VEN.

String

status

The current status of the VEN. Options are:

"active", "suspended", "uninstalled."

String

activation_type

The method in which the VEN was activated. Options are:

"pairing_key", "kerberos", "certificate."

String, Null

No

active_pce_fqdn

The FQDN of the PCE that the VEN last connected to

String, Null

No

target_pce_fqdn

cluster FQDN for target PCE

String, Null

labels

Labels assigned to the host that are managed by the VEN.

Array

interfaces

Network interfaces of the host that are managed by the VEN.

Array

workloads

The only required property is HREF; the others are optional:

name, managed, hostname,

os_id, os_detail, labels,

interfaces, etc.

Array

description

Description of VEN(s) to return. Supports partial matches

String, Null

last_heartbeat_at

The last time (rfc3339 timestamp) a heartbeat was received from this VEN.

String, Null

status

VEN Status:

String

ven_type

The ven_type property is introduced through the reference to a common schema ven_type.schema.json:

String

No

ven_type

The type of the release marked as default:

"server", "endpoint"

String

No

default_release_ ven_types

The type of the release marked as default

String

name

Friendly name for the VEN

String, Null

hostname

The hostname of the host managed by the VEN

String, Null

Yes

uid

The unique ID of the host managed by the VEN

String, Null

os_id

OS identifier of the host managed by the VEN

String, Null

os_detail

Additional OS details from the host managed by the VEN

Sring, Null

os_platform

OS platform of the host managed by the VEN

String, Null

version

Software version of the VEN.

String

status

The current status of the VEN. Options are:

"active", "suspended", "uninstalled"

String

activation_type

The method in which the VEN was activated. Options are:

"pairing_key", "kerberos", "certificate"

String, Null

No

active_pce_fqdn

The FQDN of the PCE that the VEN last connected to

String, Null

No

target_pce_fqdn

cluster FQDN for target PCE

String, Null

labels

Labels assigned to the host managed by the VEN.

Array

interfaces

Network interfaces of the host managed by the VEN.

Array

workloads

The only required property is HREF, the others are optional:

name, managed, hostname,

os_id, os_detail, labels,

interfaces, etc.

managed: True if the workload is managed, else false.

Array

container_clusters

The array of container cluster URIs, encoded as a JSON string

Object

No

secure_connect

The issuer name match the criteria for the certificate used when establishing secure connections.

Object, Null

last_heartbeat_at

The last time (rfc3339 timestamp), a heartbeat was received from this VEN.

String, Null

last_goodbye_at

The time (rfc3339 timestamp) of the last goodbye from the VEN.

String, Null

status

VEN Status:

String

disconnected_before

Return VENs that have been disconnected since the given time.

date/time

health

The overall health (condition) of the VEN

String

ip_address

IP address of VEN(s) to return. Supports partial matches

String

firewall_restore

The strategy to use to restore the firewall state after the VEN is uninstalled.

The strategy to use to restore the firewall state after the VEN is uninstalled:

Options are: saved, default, and disable.

The default is: default.

Works with vens_unpair_put.

String

ven_id

VEN ID (works with GET /api/v2/orgs/{org_id}/vens/{ven_id})

String

vens

VENs to unpair (works with PUT /api/v2/orgs/{org_id}/vens/unpair)

Required property: href

Array

Yes

secure_connect

Property: matching_issuer_name.

Issuer name match criteria for certificate used during establishing secure connections.

matching_issuer_name: Issuer name match criteria for certificate used while establishing secure connections.

Object

String

security_policy_ applied_at

Last reported time when policy was applied to the workload (UTC),

only present in expanded representations.

date-time

security_policy_ received_at

Last reported time when policy was received by the workload (UTC),

only present in expanded representations.

date-time

Null

enforcement_mode

Policy enforcement mode, only present in expanded representations.

Options are: "idle", "visibility_only", "full", "selective"

String

visibility_level

The amount of data the VEN collects and reports to the PCE from a resource demands on workloads.

The higher levels of detail are useful for visualizing traffic flows in the Illumination map inside the PCE web console.

If this parameter is not set, then VEN visibility level is set to flow_summary.

String

upgrade_pending

Only return VENs with/without a pending upgrade.

Boolean

No

ven_type

The ven_type property is introduced through the reference to a common schema ven_type.schema.json:

String

No

upgrade_expires_at

The time (rfc3339 timestamp) at which the PCE stops attempting VEN upgrade

String. Null

No

upgrade_target_ version

The software release to upgrade to

String, Null

No

upgrade_timeout_ seconds

Number of seconds during which the PCE tries to trigger the agent upgrade:

"minimum": 900,

"maximum": 15552000

Integer