Skip to main content

List PrefixLists

GET 
/v1/config/rulestacks/:rulestackname/prefixlists

Retrieve the information about the prefix lists for the specified rulestack.

Request​

Path Parameters

    rulestackname stringrequired

Query Parameters

    nexttoken Nexttoken

    Possible values: non-empty and <= 2048 characters, Value must match regular expression ^[-0-9A-Za-z:\/+=]+$

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

    candidate Candidate

    Default value: true

    Prefix list candidate.

    running Running

    Prefix lists in run state.

    uncommitted Uncommitted

    Uncommitted prefix lists.

    maxresults Maxresults

    Possible values: >= 1 and <= 1024

    Default value: 1024

    The maximum number of prefix lists that you want NGFW to return for this request.

Responses​

OK

Schema
    Response object

    The API call response.

    NextToken Nexttoken (string)

    Possible values: non-empty and <= 2048 characters, Value must match regular expression ^[-0-9A-Za-z:\/+=]+$

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

    PrefixListCandidate string[]

    Prefix list candidate.

    PrefixListRunning string[]

    Prefix lists on run state.

    PrefixListUncommitted object[]

    Uncommitted Prefix lists.

  • Array [
    • Name Name (string)required

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^[a-zA-Z0-9-]+$

    Name of the prefix list.

    Operation Operation (string)required

    Prefix list operation.

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