New APIs

The following table lists the APIs Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. introduced in the current release:

Table 1: New APIs

New API

Description

Cloud Connect > Cloud connect

This API is introduced to create the Cloud VPN Virtual Private Network. VPN enables secure access to a corporate network when located remotely. It enables a computer to send and receive data across shared or public networks as if it were directly connected to the private network, while benefiting from the functionality, security, and management policies of the private network. This is done by establishing a virtual point-to-point connection through the use of dedicated connections, encryption, or a combination of the two. Connect Service endpoint configurations for Prisma Cloud service provider.
  • [PUT] /cloud-connect/v1/node_list/{node_id}/config/prisma

This API is introduced to update and modify the Cloud VPN Connect Service endpoint configurations for Prisma Cloud service provider.
  • [DELETE] /cloud-connect/v1/node_list/{node_id}/config/prisma

This API is introduced to delete the Cloud VPN Connect Service endpoint configurations for Prisma Cloud service provider.

This API is introduced to fetch the list of Tunnel Policy configurations.
  • [GET] /cloud-connect/v1/custom-account/{account_name}

This API is introduced to fetch the custom cloud account configuration for the specified account name.
  • [PUT] /cloud-connect/v1/custom-account/{account_name}

This API is introduced to update an existing custom cloud account configuration for the specified account name.
  • [POST] /cloud-connect/v1/custom-account/{account_name}

This API is introduced to create a custom cloud account configuration for the specified account name.
  • [DELETE] /cloud-connect/v1/custom-account/{account_name}

This API is introduced to delete custom cloud account configuration for the specified account name.
  • [GET] /cloud-connect/v1/prisma-account/{account_name}

This API is introduced to fetch Prisma Cloud account configuration for the specified account name.
  • [PUT] /cloud-connect/v1/prisma-account/{account_name}

This API is introduced to update the Prisma Cloud account configuration for the specified account name.
  • [POST] /cloud-connect/v1/prisma-account/{account_name}

This API is introduced to create a new Prisma Cloud account configuration for the specified account name.
  • [DELETE] /cloud-connect/v1/prisma-account/{account_name}

This API is introduced to delete Prisma Cloud account configuration for the specified account name.

Device Replacement > Offline Devices

  • [GET] /v1/offline_device

This API is introduced to get a list of all offline devices.

Device Replacement > Request Replacement

  • [POST] /v1/request_replacement

This API is introduced to request the replacement of a single device or devices in bulk.

Device Replacement > Check Compliance

  • [POST] /v1/check_compliance

This API is introduced to determine whether the model numbers of the new and faulty devices match and if they are present in the inventory. These are pre-requisites before initiating a device replacement.

NOTE: The model number of the faulty and new devices must be the same for device replacement.

Device Replacement > Initiate Replacement
  • POST] /v1/initiate_replacement

This API is introduced to initiate replacement for a single device or bulk devices.

Device Replacement > Cancel Replacement

  • [POST] /v1/cancel_replacement

This API is introduced to cancel replacement request for a single device or bulk devices.

Device Replacement > Devices Under Replacement

  • [GET] /v1/devices

This API is introduced to fetch the list of devices under replacement.

Device Replacement > Devices Status

  • [GET] /v1/device_status

This API is introduced to fetch the replacement status of a device using the devices serial number.

Device Replacement > Devices count

  • [GET] /v1/device_count

This API is introduced to get the count of devices under replacement for a given site. You can get the device count for following categories:

  • Device requested for replacement
  • Device initiated for replacement
  • Devices that have completed replacement

Device Replacement > Get MSP Managed Service Provider. The Managed Service Provider (MSP) mode is a multi-tenant operational mode that Aruba Central accounts can be converted into, provided these accounts have subscribed to the Aruba Central app. customers

  • [GET] /v1/msp_customers

This API is introduced to get the list of tenants under the specified MSP account.

Device Replacement > MSP Replacement Count

  • [GET] /v1/msp_replacement_count

This API is introduced to get the count of devices under replacement for a MSP customer. You can get the device count for following categories:

  • Device requested for replacement
  • Device initiated for replacement
  • Devices that have completed replacement

Device Replacement > MSP replacement detail

  • [GET] /v1/msp_replacement_details

The API is introduced to get replacement information of all tenants under that MSP Account.

IDS Intrusion Detection System. IDS monitors a network or systems for malicious activity or policy violations and reports its findings to the management system deployed in the network. > Detection Protection

 

  • [GET] /network-config/v1appha1/ids/{name}/detection-protection/laa-counter-msg

This API is introduced to fetch the Locally Administered Address (LAA) or random MAC Media Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network. address and interval parameters of a specific IDS profile.

  • [POST] /network-config/v1appha1/ids/{name}/detection-protection/laa-counter-msg

This API is introduced to create or configure the Locally Administered Address (LAA) or random MAC address and interval parameters for a specific IDS profile.

Monitoring > Switch

  • [GET] /monitoring/v1/cx_switches/{serial}/neighbors

This API is introduced to fetch lldp device neighbor list information for the AOS-CX switch. The serial number of the switch is required as an input parameter.
  • [GET] /monitoring/v1/cx_switch_stacks/{stack_id}/neighbors

This API is introduced to fetch lldp device neighbor list information for CX switch. The stack-id of the VSF Virtual Switching Framework. VSF allows network administrators to stack multiple individual switches into a single logical device using standard Ethernet links.-switch is required as an input parameter to call the API.

Service UCC Unified Communications and Collaboration. UCC is a term used to describe the integration of various communications methods with collaboration tools such as virtual whiteboards, real-time audio and video conferencing, and enhanced call control capabilities. > Aruba ucc

  • [POST] /ucc-config/v1/node_list/{node_type}/{node_id}/config/ucc_alg/zoom/

This API is introduced to create DSCP Differentiated Services Code Point. DSCP is a 6-bit packet header value used for traffic classification and priority assignment. Priority configuration for Zoom using HPE Aruba Networking UCC.
  • [PUT] /ucc-config/v1/node_list/{node_type}/{node_id}/config/ucc_alg/zoom/

This API is introduced to update DSCP Priority configuration for Zoom using HPE Aruba Networking UCC.
  • [GET] /ucc-config/v1/node_list/{node_type}/{node_id}/config/ucc_alg/zoom/

This API is introduced to fetch information of DSCP Priority configuration for Zoom in HPE Aruba Networking UCC.
  • [DELETE] /ucc-config/v1/node_list/{node_type}/{node_id}/config/ucc_alg/zoom/

This API is introduced to delete DSCP Priority configuration for Zoom in HPE Aruba Networking UCC.s

To view the APIs introduced in previous releases, see APIs Introduced In Previous Releases.