Skip to main content

List Custom URL Categories

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

Retrieve the data of the custom URL categories for a specified rulestack.

Request​

Path Parameters

    rulestackname stringrequired

    The name of the rulestack.

Query Parameters

    nexttoken Nexttoken

    If the number of custom URL categories available for retrieval exceeds the maximum you requested, Cloud NGFW returns a NextToken value in response. To retrieve the next batch of URLs, use this token in your next request.

    candidate Candidate

    Default value: true

    Rulestack candidate.

    running Running

    Rulestacks in run state.

    uncommitted Uncommitted

    Uncommitted rulestacks.

    maxresults Maxresults

    Possible values: >= 1 and <= 1024

    Default value: 1024

    The maximum number of custom URL categories you want Cloud NGFW to return for this request.

Responses​

OK

Schema
    Response object

    The API call response.

    CategoriesCandidate string[]

    Custom URL category candidate.

    CategoriesPreDefined string[]

    Predefined URL category candidate

    CategoriesRunning string[]

    Custom URLs on run state.

    CategoriesUncommitted object[]

    Uncommitted custom URLs.

  • Array [
    • Name Name (string)required

    Name of the custom URL category.

    Operation Operation (string)required
  • ]
    • NextToken Nexttoken (string)

    If the number of custom URL categories available for retrieval exceeds the maximum you requested, Cloud NGFW returns a NextToken value in response. To retrieve the next batch of URLs, use this token in your next request.

    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.
    • 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...