get-ssl-vpn-account-list

Prev Next

Available in VPC

Get the list of SSL VPN accounts registered in Data Box.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/export/get-ssl-vpn-account-list

Request headers

For information about the headers common to all Data Box Frame APIs, see Data Box Frame request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
dataBoxFrameNo Integer Required Data Box Frame number
dataBoxNo Integer Required Data Box number

Request example

The request example is as follows:

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/export/get-ssl-vpn-account-list?dataBoxFrameNo=83&dataBoxNo=381' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
content Array - SSL VPN account list

content

The following describes content.

Field Type Required Description
sslVpnNo String - SSL VPN ID number
vpnId String - VPN ID
email String - Email address registered on the VPN ID
  • Displayed with masking
countryCode String - Country code
phoneNumber String - Phone number registered to the VPN ID
  • Displayed with masking

Response status codes

For information about the response status codes common to all Data Box Frame APIs, see Data Box Frame API response status codes.

Response example

The response example is as follows:

{
    "content": [
        {
            "sslVpnNo": "776",
            "vpnId": "**********",
            "email": "n*******@navercorp.com",
            "countryCode": "82",
            "phoneNumber": "01040*******"
        }
    ]
}