Skip to main content

List Firewall Resources

GET 
/v1/config/ngfirewalls

List all NGFWs in the Global Firewall Admin (FMS) account and retrieve the metadata for the NGFW policies that you have defined.

Request​

Body

    MaxResults Maxresults (integer)

    Possible values: >= 1 and <= 1024

    Default value: 1024

    The maximum number of firewalls 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 NGFWs available for retrieval exceeds the maximum you requested, Cloud NGFW returns a NextToken value in response. To retrieve the next batch of NGFWs, use this token in your next request.

    RuleStackName Rulestackname (string)
    VpcIds string[]

    The unique identifier of the VPCs that you want NGFW to retrieve. Leave this blank to retrieve all VPCs.

Responses​

OK

Schema
    Response object

    The API call response.

    Firewalls object[]

    The list of NGFWs.

  • Array [
    • AccountId Accountid (string)

    The unique ID of the account.

    FirewallName Firewallname (string)required

    Name of the NGFW, unique in a region for each customer.

  • ]
    • NextToken Nexttoken (string)

    If the number of NGFWs available for retrieval exceeds the maximum you requested, Cloud NGFW returns a NextToken value in response. To retrieve the next batch of NGFWs, 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...