Skip to main content

Update A Firewall Resource Description

PUT 
/v1/config/ngfirewalls/:ngfirewallname/description

Modifies the description of a specific NGFW. Use the description to help identify the NGFW when you are working with it.

Request​

Path Parameters

    ngfirewallname stringrequired

    The name of the NGFW.

Body

    AccountId Accountid (string)

    The unique ID of the account.

    Description Description (string)required

    Possible values: <= 512 characters, Value must match regular expression ^.*$

    Description of the firewall.

    UpdateToken Updatetoken (string)

    Refresh token.

Responses​

OK

Schema
    Response object

    The API call response.

    AccountId Accountid (string)

    The unique ID of the account.

    Description Description (string)

    Description of the firewall.

    FirewallName Firewallname (string)

    Name of the NGFW, unique in a region for each customer.

    UpdateToken Updatetoken (string)

    Refresh token.

    ResponseStatus object

    The API call response status.

    ErrorCode Errorcode (integer)

    Default value: 0

    Default value of a successful response is 0. Any other number indicates an error code.

    400—HTTP bad request

    • InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.
    • ResourceNotFoundException—Unable to locate a resource using the parameters you provided.
    • ThrottlingException—Operation failed due to throttling limitations.

    500—Bad request

    • InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.
    Reason Reason (string)

    The error description.

Loading...