MENU
      updateAddressGroup

        updateAddressGroup


        Article summary

        Available in Classic

        Edit address group information.

        Request

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

        MethodURI
        POST/{type}/{zone}/updateAddressGroup

        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
        newAddressGroupNameStringOptionalAddress group name to edit
        • Maintain existing name if not entered
        addressGroup.addressGroupNoIntegerOptionalUnique number assigned to the address group
        addressGroup.addressGroupNameStringRequiredExisting address group name
        addressGroup.addressList[]ArrayOptionalInformation about addresses that belong to the address group
        addressGroup.addressList[].addressNoIntegerOptionalUnique number assigned to the address
        addressGroup.addressList[].addressZoneStringRequiredInformation for the zone the address belongs to
        • sz | os | vm | db | vpn | lb | kr1
          • sz: Secure Zone
          • os: Object Storage
          • vm: VM
          • db: Cloud DB
          • vpn: SSL VPN or IPsec VPN
          • lb: Load Balancer
          • kr1: KR-1 zone
        addressGroup.addressList[].fqdnStringConditionalFull domain name (FQDN)
        • Required if type is fqdn
        addressGroup.addressList[].ipStringConditionalIP address
        • Required if type is ipmask
        addressGroup.addressList[].maskBitIntegerOptionalSubnet mask bit value
        • Available in the Secure Zone Advanced type
        addressGroup.addressList[].nameStringRequiredAddress name
        addressGroup.addressList[].portStringOptionalPort number
        • Enter if addressZone is db and type is fqdn
        addressGroup.addressList[].typeStringOptionalAddress type information
        • ipmask (default) | fqdn
          • ipmask: address defined by IP address and subnet mask
          • fqdn: fully qualified domain name (full domain name)
        addressGroup.addressZoneStringOptionalInformation about the zone to which the address group belongs
        • Use information from the zone the first address in the child AddressList belongs to when not entered
        addressGroup.descriptionStringOptionalAddress group description
        addressGroup.objectStorageBooleanOptionalWhether to use Object Storage
        • true | false (default)
          • true: Object Storage is used
          • false: Object Storage is not used

        Request example

        The following is a sample request.

        curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr1/updateAddressGroup'
        --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 '{
          "newAddressGroupName": "test-grp",
          "addressGroup": {
            "addressGroupNo": 0,
            "addressGroupName": "grp111",
            "addressList": [
              {
                "addressNo": 0,
                "addressZone": "sz",
                "ip": "***.***.***.***",
                "maskBit": 0,
                "name": "sv-securezone",
                "type": "ipmask"
              }
            ],
            "addressZone": "sz",
            "objectStorage": true
          }
        }'
        Curl

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        actionString-Request type
        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": "updateAddressGroup",
            "returnCode": 0,
            "returnMessage": "success"
        }
        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.