Description

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

HTTP request

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

Data Parameters

Parameter Required Type Description
version False string Current version of the object
name False string User defined string name of the object
description False string User defined description for the object
Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
tags True [object] List of SecurityGroupTagEntry tag references
Field level constraints: cannot be null. (Note: Additional constraints might exist)
id False string UUID
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string SGTDynamicObject object type

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 '{
        "description": "string",
        "id": "string",
        "name": "string",
        "tags": [
            {
                "externalId": "string",
                "name": "string",
                "tag": 0,
                "type": "securitygrouptagentry"
            }
        ],
        "type": "sgtdynamicobject",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/object/sgtdynamicobjects/{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_sgt_dynamic_object(client, obj_id, body):
    return client.SGTDynamicObject.editSGTDynamicObject(
        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 = {'description': 'string',
 'id': 'string',
 'name': 'string',
 'tags': [{'externalId': 'string',
           'name': 'string',
           'tag': 0,
           'type': 'securitygrouptagentry'}],
 'type': 'sgtdynamicobject',
 'version': 'string'}

    edit_sgt_dynamic_object(client, obj_id, body)