Description

The editDomainNameGroup operation handles configuration related to DomainNameGroup model. 
This API call is not allowed on the standby unit in an HA pair.

HTTP request

PUT /api/fdm/v6/object/domainnamegroups/{objId}

Data Parameters

Parameter Required Type Description
version False string A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name False string A string that represents the name of the object
domainNames False [string] A list of domain names, for example, 'example.com'. You can use asterisk next to or between dots to act as wildcards. For example, '.example.com' matches any fully-qualified domain name on the example.com domain, whereas 'blog..com' matches any host named 'blog' on all networks within the '.com' domain.
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter Required Type Description
objId True string

Example

curl -X PUT \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "domainNames": [],
        "id": "string",
        "name": "string",
        "type": "domainnamegroup",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/object/domainnamegroups/{objId}"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def edit_domain_name_group(client, obj_id, body):
    return client.SecurityIntelligence.editDomainNameGroup(
        objId=obj_id,
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    obj_id = "string"
    body = {'domainNames': [],
 'id': 'string',
 'name': 'string',
 'type': 'domainnamegroup',
 'version': 'string'}

    edit_domain_name_group(client, obj_id, body)