MENU
      getIpsecAddress

        getIpsecAddress


        Article summary

        Available in Classic

        Get the list of addresses that belong to the IPsec zone.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        POST/{type}/{zone}/getIpsecAddress

        Request headers

        For headers common to Secure Zone APIs, see Secure Zone request headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        typeStringRequiredfirewall type provided by Secure Zone
        • szfw | psfw
          • szfw: Secure Zone Standard
          • psfw: Secure Zone Advanced
        zoneStringRequiredZone in which Secure Zone is configured
        • kr1 | kr2
          • kr1: KR-1 zone
          • kr2: KR-2 zone

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        memberNoStringOptionalUser's NAVER Cloud Platform member ID
        instanceNoStringOptionalContract number assigned when creating the instance

        Request example

        The following is a sample request.

        curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/psfw/kr2/getIpsecAddress'
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'x-ncp-mbr_no: {User number}' \
        --header 'Content-Type: application/json' \
        --data '{
          "memberNo": "27***85",
          "instanceNo": "25****11"
        }'
        Curl

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        actionString-Request type
        addressList[]Array-List of addresses to view
        addressList[].addressNoInteger-Unique number assigned to the address
        addressList[].addressZoneString-Information about the zone the address belongs to
        • vpn
          • vpn: IPsec VPN
        addressList[].dbAddressZoneBoolean-DB address zone status
        addressList[].fqdnString-Full domain name (FQDN)
        addressList[].instanceNoString-Contract number assigned when creating the instance
        addressList[].ipString-IP address
        addressList[].maskBitInteger-Subnet mask bit value
        • It is displayed for the Secure Zone Advanced type
        addressList[].memberNoString-User's NAVER Cloud Platform member ID
        addressList[].nameString-Address name
        addressList[].portInteger-Port number
        • It is displayed if addressZone is db and type is fqdn
        addressList[].typeString-Address type information
        • ipmask | fqdn
          • ipmask: address defined by IP address and subnet mask
          • fqdn: fully qualified domain name (full domain name)
        returnCodeInteger-Response code
        returnMessageString-Response message

        Response status codes

        For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

        Response example

        The following is a sample example.

        {
          "action": "string",
          "addressList": [
            {
              "addressNo": 0,
              "addressZone": "string",
              "fqdn": "string",
              "instanceNo": "string",
              "ip": "string",
              "maskBit": 0,
              "memberNo": "string",
              "name": "string",
              "port": "string",
              "type": "ipmask"
            }
          ],
          "returnCode": 0,
          "returnMessage": "string"
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.