Skip to main content

Describe A Firewall Resource

GET 
/v1/config/ngfirewalls/:ngfirewallname

Returns the data of a specific NGFW resource.

Request​

Path Parameters

    ngfirewallname stringrequired

    The name of the NGFW.

Body

    AccountId Accountid (string)

    The unique ID of the account.

Responses​

OK

Schema
    Response object

    The API call response.

    Firewall object
    AccountId Accountid (string)

    The unique ID of the account.

    AppIdVersion Appidversion (string)

    Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9]+-[0-9]+$

    The App-ID version of the specified application.

    AutomaticUpgradeAppIdVersion Automaticupgradeappidversion (boolean)

    Default value: true

    Specify whether to automatically upgrade to the latest App-ID version.

    Description Description (string)

    Description of the NGFW.

    EndpointMode Endpointmode (string)required

    Possible values: [ServiceManaged, CustomerManaged]

    The management mode used to create endpoints automatically or manually.

    EndpointServiceName Endpointservicename (string)

    Default value: Creating

    FirewallName Firewallname (string)required

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

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

    GlobalRuleStackName Globalrulestackname (string)

    Name of the global rulestack.

    RuleStackName Rulestackname (string)

    Name of the local rulestack.

    SubnetMappings object[]required

    The public subnets for your NGFW. Each subnet must belong to a different Availability Zone in the VPC. NGFW creates an NGFW endpoint in each subnet.

    Tags object[]

    The key:value pairs to associate with a resource.

    UpdateToken Updatetoken (string)

    Default value: 1

    Refresh token.

    VpcId Vpcid (string)required

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

    Status object

    Status of NGFW.

    Attachments object[]required

    The endpoint attachment.

  • Array [
    • EndpointId Endpointid (string)required

    The unique ID of the endpoint.

    RejectedReason Rejectedreason (string)

    Reason of rejection.

    Status Status (string)required

    Possible values: [ACCEPTED, PENDING, REJECTED]

    SubnetId Subnetid (string)

    The unique ID of the subnet in your VPC.

  • ]
    • FailureReason Failurereason (string)

    The reason for failure.

    FirewallStatus Firewallstatus (string)required

    Possible values: [CREATING, UPDATING, DELETING, CREATE_COMPLETE, UPDATE_COMPLETE, CREATE_FAIL, UPDATE_FAIL, DELETE_FAIL]

    RuleStackStatus Rulestackstatus (string)

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