REST APIs for 22.5

target_pce_fqdn

Cluster FQDN for the target PCE

String

No

name

Friendly name for the VEN

String, NULL

No

status

The current status of the VEN. Options are:

"active", "suspended", "uninstalled"

String

No

hostname

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

String

No

os_id

Operating System of VEN(s) to return. Supports partial matches.

String

uid

The unique ID of the host managed by the VEN

String

No

os_detail

Additional OS details from the host managed by the VEN

String

os_platform

OS platform of the host managed by the VEN

String

No

version

Software version of the VEN. Two parameters are used:

version[gte]: Greater than or equal to value for version

version[lte]: Less than or equal to value for version

String

status

activation_type

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

"pairing_key", "kerberos", "certificate"

String

No

active_pce_fqdn

The FQDN of the PCE that the VEN last connected to

String

No

labels

Labels assigned to the host managed by the VEN.

String

interfaces

container_clusters

Array of container cluster URIs, encoded as a JSON string

String

No

org_id

Organization

Integer

Yes

authentication_recovery

Return VENs in or not in authentication recovery

Boolean

No

condition

A specific error condition to filter by

String

No

disconnected_before

Return VENs that have been disconnected since the given time

date/time

ip_address

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

String

last_goodbye_at

The time (rfc3339 timestamp) of the last goodbye from the VEN. There are two parameters:

last_goodbye_at[gte]: Greater than or equal to value for last goodbye at timestamp

last_goodbye_at[lte]: Less than or equal to value for last goodbye at timestamp

Bollean

last_heartbeat_at

The last time (rfc3339 timestamp) a heartbeat was received from this VEN. There are two parameters:

last_heartbeat_at[gte]: Greater than or equal to value for last heartbeat timestamp

last_heartbeat_at[lte]: Less than or equal to value for last heartbeat timestamp

Boolean

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:

{
  "properties": {	 
     "ven_type": { 
   "$ref": "../common/ven_type.schema.json"
}

String

No

href

URI of the VEN

Stgring

hostname

The hostname of the host managed by the VEN

String

Yes

name

Friendly name for the VEN

String

uid

The unique ID of the host managed by the VEN

String

os_id

OS identifier of the host managed by the VEN

String

os_detail

Additional OS details from the host managed by the VEN

Sring

os_platform

OS platform of the host managed by the VEN

String

version

Software version of the VEN. Two parameters are used:

version[gte]: Greater than or equal to value for version

version[lte]: Less than or equal to value for version

String

interfaces

Network interfaces of the workload, only present in expanded representations

Array

workloads

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

name, managed, hostname, instance_id, data_center, data_center_zone, service_principal_name, etc.

Array

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

enforcement_mode

Policy enforcement mode, only present in expanded representations.

Reference to common/workload_enforcement_mode.schema.json

String

visibility_level

Visibility level of the workload, only present in expanded representations

String