Skip to main content

Describe Custom URL Category

GET 
/v1/config/rulestacks/:rulestackname/urlcustomcategories/:name

Return the custom URL category of a specified rule group. This command describes custom categories and the default predefined ones.

Request​

Path Parameters

    rulestackname stringrequired

    The name of the rulestack.

    name stringrequired

    URL Category.

Query Parameters

    running Running

    Default value: true

    Rulestacks in run state.

    candidate Candidate

    Rulestack candidate.

Responses​

OK

Schema
    Response object

    The API call response.

    Name Name (string)

    Name of the custom URL entry.

    RuleStackName Rulestackname (string)

    Name of the rulestack.

    URLCategoryCandidate object

    The custom URL candidate.

    URLCategoryEntry object

    The custom URL category 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.

    operation Operation (string)

    Possible values: [add, update, delete]

    Custom URL operation.

    pk Pk (string)required
    sk Sk (string)required

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

    URLCategoryRunning object

    The custom URLs on run state.

    URLCategoryEntry object

    The custom URL category 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.

    operation Operation (string)

    Possible values: [add, update, delete]

    Custom URL operation.

    pk Pk (string)required
    sk Sk (string)required

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

    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.
    • 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.
    Reason Reason (string)

    The error description.

Loading...