Obtaining On-premises Devices Whose VPN Connection Configurations Can Be Exported

Function

This API is used to obtain on-premises devices whose VPN connection configurations can be exported.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, the following identity policy-based permissions are required.

URI

GET /v5/{project_id}/peer-configuration/supported-devices

Request

• Request parameters

  None

• Example request

  GET https://{Endpoint}/v5/{project_id}/peer-configuration/supported-devices

Response

• Response parameters

  Returned status code 200: successful operation

  Table 2 Parameters in the response body

  Parameter	Type	Description
  request_id	String	Specifies a request ID.
  supported_devices	SupportedDevice Object	Specifies supported devices.

  Table 3 SupportedDevice

  Parameter	Type	Description
  vendor	String	Specifies a vendor.
  type	String	Specifies a device series.
  model	String	Specifies a device model.
  version	String	Specifies a device version.

• Example response

  {
      "supported_devices": [
          {
              "vendor": "vendor-name-1",
              "type": "type-1",
              "model": "model-1",
              "version": "1.0"
          },
          {
              "vendor": "vendor-name-2",
              "type": "type-2",
              "model": "model-2",
              "version": "1.0"
          }
      ],
      "request_id": "44b94ae1f579e74526627b5a1a1a6428"
  }

Status Codes

For details, see Status Codes.