List Firewall Tags

GET 
/v1/config/ngfirewalls/:ngfirewallname/tags

Retrieve the tags associated with an NGFW resource.

Request

Path Parameters

ngfirewallname stringrequired

The name of the NGFW.

application/json

Body

AccountId Accountid (string)required

The unique ID of the account.

MaxResults Maxresults (integer)

Possible values: >= 1 and <= 1024

Default value: 1024

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

NextToken Nexttoken (string)

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

Responses

200

OK

application/json

Schema

Schema

Response object
AccountId Accountid (string)
The unique ID of the account.
FirewallName Firewallname (string)
Name of the NGFW, unique in a region for each customer.
NextToken Nexttoken (string)
If the number of tags available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of tags, use this token in your next request.
Tags object[]
The tags associated with the firewall.
Array [
Key Key (string)required
A unique identifier in the key-value pair. The constant that defines the data set.
Value Value (string)required
The variable that belongs to the data set.
]
ResponseStatus object

ErrorCode Errorcode (integer)

Default value: 0

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

Example (from schema)

{
  "Response": {
    "AccountId": "string",
    "FirewallName": "string",
    "NextToken": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseStatus": {
    "ErrorCode": 0,
    "Reason": "string"
  }
}

Loading...