Skip to main content

List Security Rules

GET 
/v1/config/rulestacks/:rulestackname/rulelists/:rulelistname

List the security rules associate with a specified rulestack in the order of priority.

Request​

Path Parameters

    rulestackname stringrequired

    The name of the rulestack.

    rulelistname stringrequired

    The name of the rulelist.

Query Parameters

    nexttoken Nexttoken

    If the number of rulestacks available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of rulestacks, 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 rulestacks that you want NGFW to return for this request.

Responses​

OK

Schema
    Response object
    NextToken Nexttoken (string)

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

    RuleEntryCandidate object[]

    The rules entry candidate.

  • Array [
    • Priority Priority (integer)required

    Possible values: > 0 and < 1000001

    The priority of the rule.

    RuleName Rulename (string)

    Name of the rule.

  • ]
    • RuleEntryRunning object[]

    Rule entry in run state.

  • Array [
    • Priority Priority (integer)required

    Possible values: > 0 and < 1000001

    The priority of the rule.

    RuleName Rulename (string)

    Name of the rule.

  • ]
    • RuleEntryUncommitted object[]
  • Array [
    • Operation Operation (string)required

    The rule action.

    Priority Priority (integer)required

    The priority of the rule.

    RuleName Rulename (string)required

    Name of the rule.

  • ]
    • RuleListName Rulelistname (string)

    Name of the rule list.
    Length: 0-128 characters, Pattern: ^[a-zA-Z0-9-]+$

    RuleStackName Rulestackname (string)

    The name of the rulestack.

    ResponseStatus object
    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, value, priority, or length in the request.
    • ResourceNotFoundException—Unable to locate a resource using the parameters you provided. For example, RuleListName is not found, Priority is not found.
    • 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...