Palo Alto Networks Resolver Info API
The Resolver Info API from Palo Alto Networks — 1 operation(s) for resolver info.
The Resolver Info API from Palo Alto Networks — 1 operation(s) for resolver info.
openapi: 3.2.0
info:
contact:
email: support@paloaltonetworks.com
name: Palo Alto Networks Technical Support
url: https://support.paloaltonetworks.com
description: These APIs are used to define how Advanced DNS Security Resolver configurations are implemented.
license:
name: MIT
url: https://opensource.org/license/mit
termsOfService: https://www.paloaltonetworks.com/content/dam/pan/en_US/assets/pdf/legal/palo-alto-networks-end-user-license-agreement-eula.pdf
title: Advanced DNS Security Resolver Configuration Resolver Info API
version: 1.0.0
servers:
- description: Prod
url: https://api.strata.paloaltonetworks.com
security:
- scmToken: []
tags:
- name: Resolver Info
paths:
/adns-resolver/v1/resolver-info:
get:
description: Retrieve ADNS resolver IP information.
operationId: GetResolverInfo
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/resolver-info'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Not Found
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Method Not Allowed
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Conflict
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Precondition Failed
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Unprocessable Entity
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Internal Server Error
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Service Unavailable
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error
summary: Get resolver information
tags:
- Resolver Info
components:
schemas:
error-code:
oneOf:
- enum:
- 1001
title: 1001 - Forbidden
type: integer
- enum:
- 1002
title: 1002 - Invalid Input
type: integer
- enum:
- 1004
title: 1004 - Invalid Output
type: integer
- enum:
- 1005
title: 1005 - Internal Server Error
type: integer
- enum:
- 1006
title: 1006 - Precondition Failed
type: integer
- enum:
- 1007
title: 1007 - Method Not Allowed
type: integer
- enum:
- 1008
title: 1008 - Not Found
type: integer
- enum:
- 1009
title: 1009 - Service Unavailable
type: integer
- enum:
- 1010
title: 1010 - Duplicate Not Allowed
type: integer
- enum:
- 1011
title: 1011 - Expired License
type: integer
- enum:
- 1012
title: 1012 - Dependency Error
type: integer
- enum:
- 1013
title: 1013 - Subnet Already Verified
type: integer
- enum:
- 1014
title: 1014 - In Grace
type: integer
- enum:
- 1015
title: 1015 - Limit Exceeded
type: integer
- enum:
- 1016
title: 1016 - Duplicate Subnet Not Allowed
type: integer
- enum:
- 1017
title: 1017 - IP Limit Exceeded
type: integer
- enum:
- 1018
title: 1018 - FQDN Limit Exceeded
type: integer
- enum:
- 1019
title: 1019 - Private Subnet
type: integer
- enum:
- 1020
title: 1020 - Mapped IPv4
type: integer
- enum:
- 1021
title: 1021 - Invalid Subnet
type: integer
- enum:
- 1022
title: 1022 - Invalid Sinkhole
type: integer
- enum:
- 1023
title: 1023 - Allowed Subnet Required
type: integer
- enum:
- 1024
title: 1024 - Cross Tenant Subnet Conflict
type: integer
title: error-code
type: integer
resolver-info:
additionalProperties: false
properties:
resolver_info:
$ref: '#/components/schemas/resolver-infos'
required:
- resolver_info
type: object
error-detail:
additionalProperties: false
properties:
code:
$ref: '#/components/schemas/error-code'
description: Error code identifier
details:
description: Additional error details
items:
type: string
type:
- array
- 'null'
help:
description: URL to error documentation
type: string
message:
description: Human-readable error message
type: string
required:
- code
- message
type: object
error:
additionalProperties: false
properties:
_errors:
description: Array of error objects
items:
$ref: '#/components/schemas/error-detail'
type:
- array
- 'null'
_request_id:
description: Request identifier for tracking
type: string
required:
- _errors
type: object
resolver-infos:
additionalProperties: false
properties:
doh_endpoint:
description: DNS over HTTPS endpoint
examples:
- https://dns.example.com/dns-query
type: string
primary_ip:
description: Primary IPv4 address of the resolver
examples:
- 8.8.8.8
type: string
primary_ipv6:
description: Primary IPv6 address of the resolver
examples:
- 2001:4860:4860::8888
type: string
secondary_ip:
description: Secondary IPv4 address of the resolver
examples:
- 8.8.4.4
type: string
secondary_ipv6:
description: Secondary IPv6 address of the resolver
examples:
- 2001:4860:4860::8844
type: string
required:
- primary_ip
- secondary_ip
- doh_endpoint
type: object
securitySchemes:
scmToken:
bearerFormat: JWT
description: "Advanced DNS Security Resolver APIs authenticate client requests using the \nOAuth 2.0 Client Credentials flow. Please use the `client_id`, \n`client_secret` values associated with an IAM service account along \nwith a scope value of `tsg_id:XXXXXXXXXX`, where `XXXXXXXXXX` is the \nTenant Service Group (TSG) ID. The resulting JWT access token should \nbe attached to all API calls as a `Bearer` token in the `Authorization` \nheader (ex. `Authorization: Bearer tokenstring`).\n"
scheme: bearer
type: http