List GlobalProtect infrastructure settings
GET/infrastructure-settings
Retrieve a list of GlobalProtect infrastructure settings
Request
Query Parameters
name stringrequired
The name of the configuration resource
folder anyrequired
The folder in which the resource is defined
Responses
- 200
- 400
- 401
- 403
- 404
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- ]
type
items object
id stringrequired
UUID of the resource
name stringrequired
dns_servers object[]required
name string
dns_suffix string[]
internal_dns_match object[]
name string
domain_list string[]
primary object
dns_server object
use_cloud_default object
secondary object
dns_server object
use_cloud_default object
primary_public_dns object
dns_server string
secondary_public_dns object
dns_server string
enable_wins object
no object
yes object
wins_servers object[]
name string
primary string
secondary string
ip_pools object[]required
name string
ip_pool string[]
ipv6 boolean
portal_hostname objectrequired
custom_domain object
cname string
hostname string
ssl_tls_service_profile string
Default value: muCustomDomainSSLProfile
value is muCustomDomainSSLProfile, it will reference to the corresponding certificate under ssl-tls-service-profile automatically
default_domain object
hostname string
udp_queries object
retries object
attempts number
Possible values: >= 1
and <= 30
Maximum number of retries before trying next name server
interval number
Possible values: >= 1
and <= 30
Time in seconds for another request to be sent
[
[
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"name": "string",
"dns_servers": [
{
"name": "string",
"dns_suffix": [
"string"
],
"internal_dns_match": [
{
"name": "string",
"domain_list": [
"string"
],
"primary": {
"dns_server": {},
"use_cloud_default": {}
},
"secondary": {
"dns_server": {},
"use_cloud_default": {}
}
}
],
"primary_public_dns": {
"dns_server": "string"
},
"secondary_public_dns": {
"dns_server": "string"
}
}
],
"enable_wins": {
"no": {},
"yes": {
"wins_servers": [
{
"name": "string",
"primary": "string",
"secondary": "string"
}
]
}
},
"ip_pools": [
{
"name": "string",
"ip_pool": [
"string"
]
}
],
"ipv6": true,
"portal_hostname": {
"custom_domain": {
"cname": "string",
"hostname": "string",
"ssl_tls_service_profile": "muCustomDomainSSLProfile"
},
"default_domain": {
"hostname": "string"
}
},
"udp_queries": {
"retries": {
"attempts": 0,
"interval": 0
}
}
}
]
]
Bad Request
- application/json
- Schema
- Example (from schema)
- input_format_mismatch
- output_format_mismatch
- missing_query_parameter
- invalid_query_parameter
Schema
- Array [
- ]
_errors object[]
code string
message string
details object
help string
_request_id string
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
Input Format Mismatch
{
"_errors": [
{
"code": "E003",
"message": "Input Format Mismatch: input-format=json",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Output Format Mismatch
{
"_errors": [
{
"code": "E003",
"message": "Output Format Mismatch: output-format=json Accept=xml",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Missing Query Parameter
{
"_errors": [
{
"code": "E003",
"message": "Missing Query Parameter: name",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Invalid Query Parameter
{
"_errors": [
{
"code": "E003",
"message": "Invalid Query Parameter: location=invalid",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- auth_not_authenticated
- invalid_credential
- key_too_long
- key_expired
- need_password_change
Schema
- Array [
- ]
_errors object[]
code string
message string
details object
help string
_request_id string
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
Not Authenticated
{
"_errors": [
{
"code": "E016",
"message": "Not Authenticated",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Invalid Credential
{
"_errors": [
{
"code": "E016",
"message": "Invalid Credential",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Key Too Long
{
"_errors": [
{
"code": "E016",
"message": "Key Too Long",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Key Expired
{
"_errors": [
{
"code": "E016",
"message": "Key Expired",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Need Password Change
{
"_errors": [
{
"code": "E016",
"message": "The password needs to be changed.",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- auth_unauthorized
Schema
- Array [
- ]
_errors object[]
code string
message string
details object
help string
_request_id string
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
Unauthorized
{
"_errors": [
{
"code": "E007",
"message": "Unauthorized",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Not Found
- application/json
- Schema
- Example (from schema)
- object_not_present
Schema
- Array [
- ]
_errors object[]
code string
message string
details object
help string
_request_id string
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
Object Not Present
{
"_errors": [
{
"code": "E005",
"message": "Object Not Present",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
General Errors
- application/json
- Schema
- Example (from schema)
- version_not_supported
- method_not_allowed
- action_not_supported
- bad_xpath
- invalid_command
- malformed_command
- session_timeout
Schema
- Array [
- ]
_errors object[]
code string
message string
details object
help string
_request_id string
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
Version Not Supported
{
"_errors": [
{
"code": "E012",
"message": "Version Not Supported",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Method Not Supported
{
"_errors": [
{
"code": "E012",
"message": "Method Not Supported",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Action Not Supported
{
"_errors": [
{
"code": "E012",
"message": "Action Not Supported: move",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Bad XPath
{
"_errors": [
{
"code": "E013",
"message": "Bad XPath",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Invalid Command
{
"_errors": [
{
"code": "E003",
"message": "Invalid Command",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Malformed Command
{
"_errors": [
{
"code": "E003",
"message": "Malformed Command",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Session Timeout
{
"_errors": [
{
"code": "4",
"message": "Session Timeout",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Loading...