Skip to main content

List Pre-defined URL Categories

GET 
/v1/config/urlcategories

View the predefined URL categories.

Request​

Query Parameters

    nexttoken Nexttoken

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

    maxresults Maxresults

    Possible values: >= 1 and <= 1024

    Default value: 1024

    The maximum number of predefined URL categories that you want NGFW to return for this request.

Responses​

OK

Schema
    Response object

    The API call response.

    CategoriesRunning object[]

    Predefined URL categories in run state.

  • Array [
    • Action Action (string)required

    Predefined URL category action.

    Name Name (string)required

    Name of the predefined URL category.

  • ]
    • NextToken Nexttoken (string)

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

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