List FQDNLists

GET 
https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com/v1/config/rulestacks/:rulestackname/fqdnlists

Retrieve the information about the FDQN lists for the specified rulestack.

Request

Query Parameters

nexttoken Nexttoken

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

candidate Candidate
FQDN candidate.
Default value: true
running Running
FQDNs in run state.
Default value: false
uncommitted Uncommitted
Uncommitted FQDN lists.
Default value: false
maxresults Maxresults
Possible values: >= 1 and <= 1024
The maximum number of FQDNs that you want NGFW to return for this request.
Default value: 1024
describe Describe
Retrieve FQDN information.
Default value: false

Responses

200

OK

application/json

Schema

Schema

Response object

FqdnListCandidatestring[]

FQDN list candidate.

FqdnListRunningstring[]

FQDN lists on run state.

FqdnListUncommitted object[]

Uncommitted FQDN lists.

Array [

NameName (string)required

Name of the FQDN list.

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

operationOperation (string)required

FQDN list operation.

]

NextTokenNexttoken (string)

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

RuleStackNameRulestackname (string)

Name of the rulestack.

ResponseStatus object

ErrorCodeErrorcode (integer)

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.

Default value: 0

ReasonReason (string)

The error description.

Example (auto)

{
  "Response": {
    "FqdnListCandidate": [
      "string"
    ],
    "FqdnListRunning": [
      "string"
    ],
    "FqdnListUncommitted": [
      {
        "Name": "string",
        "operation": "string"
      }
    ],
    "NextToken": "string",
    "RuleStackName": "string"
  },
  "ResponseStatus": {
    "ErrorCode": 0,
    "Reason": "string"
  }
}

• curl
• python
• go
• nodejs
• csharp
• php

• CURL

curl -L 'https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com/v1/config/rulestacks/:rulestackname/fqdnlists' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com

Parameters

nexttoken — query

candidate — query

---truefalse

running — query

---truefalse

uncommitted — query

---truefalse

maxresults — query

describe — query

---truefalse

ResponseClear

Click the Send API Request button above and see the response here!