Skip to main content

List RuleStack

GET 
/v1/config/rulestacks

Retrieve the metadata of the specified rulestack.

You can also query rulestacks based on the tags using this command, /v1/config/rulestacks?tags=<string>.
This command lists the rulestacks where the tag name starts with the string.

DynamoDB supports this command, and should be implemented as a library.

Request​

Body

    Candidate Candidate (boolean)

    Default value: true

    Rulestack candidate.

    MaxResults Maxresults (integer)

    Possible values: >= 1 and <= 1024

    Default value: 1024

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

    NextToken Nexttoken (string)

    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.

    Running Running (boolean)

    Rulestacks in run state.

    Scope Scope (string)

    Possible values: [Global, Local, All]

    Default value: All

    The scope of the rulestack.

    TagKey Tagkey (string)

    A unique identifier in the key-value pair. The constant that defines the data set.

    TagValue Tagvalue (string)

    The variable that belongs to the data set.

    Uncommitted Uncommitted (boolean)

    Uncommitted rulestacks.

Responses​

OK

Schema
    Response object
    NextToken Nexttoken (string)

    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.

    RuleStackCandidate string[]

    Rulestack candidate.

    RuleStackRunning string[]

    Rulestacks in run state.

    RuleStackUncommitted object[]

    Uncommitted rulestacks.

  • Array [
    • Operation Operation (string)

    Possible values: [add, delete, update]

    Rulestacks operation.

    RuleStackName Rulestackname (string)required

    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

    • InvalidOperationException—Operation failed because it is not valid. For example, when you delete an NGFW or rulestack in use.
    • 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.
    • InsufficientCapacityException—AWS currently does not have enough capacity to fulfill your request.
    Reason Reason (string)

    The error description.

Loading...