Skip to main content

Create Custom URL Category

POST 
/v1/config/rulestacks/:rulestackname/urlcustomcategories

Create a custom URL filtering object to specify exceptions to URL category enforcement, and to create a custom URL category based on multiple URL categories.

Request​

Path Parameters

    rulestackname stringrequired

    The name of the rulestack.

Body

    Action Action (string)

    Possible values: [none, allow, alert, block]

    Default value: none

    URL actions.

    AuditComment Auditcomment (string)

    The URL category audit remarks.

    Description Description (string)

    Possible values: <= 255 characters

    A description of the rulestack.

    Name Name (string)required

    Possible values: <= 29 characters, Value must match regular expression ^[a-zA-Z][0-9a-zA-Z-]*$

    Name of the rulestack.

    UrlTargets string[]required

    Possible values: <= 255 characters

    Specify where the URL opens.

Responses​

OK

Schema
    Response object

    The API call response.

    CustomURLEntry object

    The custom URL entry.

    Action Action (string)

    The custom URL action.

    AuditComment Auditcomment (string)

    Audit remarks.

    Description Description (string)

    Possible values: <= 255 characters

    The custom URL description.

    UpdateToken Updatetoken (string)

    Refresh token.

    UrlTargets string[]required

    Possible values: <= 255 characters

    Custom URL destination.

    Name Name (string)

    Name of the custom URL entry.

    RuleStackName Rulestackname (string)

    Name of the rulestack.

    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.
    • LimitExceededException—Operation failed due to violation in limit settings.
    • ResourceNotFoundException—Unable to locate a resource using the parameters you provided.
    • ThrottlingException—Operation failed due to throttling limitations.
    • AccessDeniedException—You do not have sufficient access to perform this action.

    500—Bad request

    • InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.
    • InsufficientCapacityException—AWS currently does not have enough capacity to fulfill your request.
    Reason Reason (string)

    The error description.

Loading...