Skip to main content

Describe a PrefixList

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

Return the prefix list associated with a rulestack.

Request​

Path Parameters

    rulestackname stringrequired

    The name of the rulestack.

    name stringrequired

    The name of the prefix list.

Body

    Candidate Candidate (boolean)

    Default value: true

    Prefix list candidate.

    MaxResults Maxresults (integer)

    Default value: 100

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

    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.

    Running Running (boolean)

    Prefix list in run state.

Responses​

OK

Schema
    Response object

    The API call response.

    Name Name (string)

    Name of the prefix list entry.

    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 lists, use this token in your next request.

    PrefixListCandidate object

    The prefix list candidate.

    AuditComment Auditcomment (string)

    Audit remarks.

    Description Description (string)

    The prefix list description.

    PrefixList string[]required

    The prefix list.

    UpdateToken Updatetoken (string)

    Default value: 1

    Refresh token.

    PrefixListRunning object

    The prefix lists on run state.

    AuditComment Auditcomment (string)

    Audit remarks.

    Description Description (string)

    The prefix list description.

    PrefixList string[]required

    The prefix list.

    UpdateToken Updatetoken (string)

    Default value: 1

    Refresh token.

    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.
    • AccessDeniedException—You do not have sufficient access to perform this action.

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