Show infrastructure settings

GET 
/sse/config/v1/mobile-agent/infrastructure-settings

List infrastructure settings for GlobalProtect.

Request

Query Parameters

folder stringrequired

Possible values: [Mobile Users]

Responses

200

List of infrastructure settings under Global Protect

application/json

Schema

Schema

data object[]
Array [
dns_servers object[]required
Array [
dns_suffix string[]
internal_dns_match object[]
Array [
domain_list string[]
name string
primary object
dns_server object
use_cloud_default object
secondary object
dns_server object
use_cloud_default object
]
name string
primary_public_dns object
dns_server string
secondary_public_dns object
dns_server string
]
enable_wins object
no object
yes object
wins_servers object[]
Array [
name string
primary string
secondary string
]
ip_pools object[]required
Array [
ip_pool string[]
name string
]
ipv6 boolean
name stringrequired
portal_hostname objectrequired
custom_domain object
cname string
hostname string
ssl_tls_service_profile string
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
]
limit number

Default value: 200

offset number

Default value: 0

total number

Example (from schema)

{
  "data": [
    {
      "dns_servers": [
        {
          "dns_suffix": [
            "string"
          ],
          "internal_dns_match": [
            {
              "domain_list": [
                "string"
              ],
              "name": "string",
              "primary": {
                "dns_server": {},
                "use_cloud_default": {}
              },
              "secondary": {
                "dns_server": {},
                "use_cloud_default": {}
              }
            }
          ],
          "name": "string",
          "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": [
        {
          "ip_pool": [
            "string"
          ],
          "name": "string"
        }
      ],
      "ipv6": true,
      "name": "string",
      "portal_hostname": {
        "custom_domain": {
          "cname": "string",
          "hostname": "string",
          "ssl_tls_service_profile": "string"
        },
        "default_domain": {
          "hostname": "string"
        }
      },
      "udp_queries": {
        "retries": {
          "attempts": 0,
          "interval": 0
        }
      }
    }
  ],
  "limit": 200,
  "offset": 0,
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

_errors object[]
Array [
code string
details object
help string
message string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "details": {},
      "help": "string",
      "message": "string"
    }
  ],
  "_request_id": "string"
}

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Input Format Mismatch: input-format=json"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Query Parameter: location=invalid"
    }
  ],
  "_request_id": "abcd-1234"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Missing Query Parameter: name"
    }
  ],
  "_request_id": "abcd-1234"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Output Format Mismatch: output-format=json Accept=xml"
    }
  ],
  "_request_id": "abcd-1234"
}

401

Unauthorized

application/json

Schema

Schema

_errors object[]
Array [
code string
details object
help string
message string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "details": {},
      "help": "string",
      "message": "string"
    }
  ],
  "_request_id": "string"
}

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Not Authenticated"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Invalid Credential"
    }
  ],
  "_request_id": "abcd-1234"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Expired"
    }
  ],
  "_request_id": "abcd-1234"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Too Long"
    }
  ],
  "_request_id": "abcd-1234"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "The password needs to be changed."
    }
  ],
  "_request_id": "abcd-1234"
}

403

Forbidden

application/json

Schema

Schema

_errors object[]
Array [
code string
details object
help string
message string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "details": {},
      "help": "string",
      "message": "string"
    }
  ],
  "_request_id": "string"
}

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "details": {},
      "message": "Unauthorized"
    }
  ],
  "_request_id": "abcd-1234"
}

404

Not Found

application/json

Schema

Schema

_errors object[]
Array [
code string
details object
help string
message string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "details": {},
      "help": "string",
      "message": "string"
    }
  ],
  "_request_id": "string"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "details": {},
      "message": "Object Not Present"
    }
  ],
  "_request_id": "abcd-1234"
}

default

General Errors

application/json

Schema

Schema

_errors object[]
Array [
code string
details object
help string
message string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "details": {},
      "help": "string",
      "message": "string"
    }
  ],
  "_request_id": "string"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Action Not Supported: move"
    }
  ],
  "_request_id": "abcd-1234"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "details": {},
      "message": "Bad XPath"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Command"
    }
  ],
  "_request_id": "abcd-1234"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Malformed Command"
    }
  ],
  "_request_id": "abcd-1234"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Method Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": 4,
      "details": {},
      "message": "Session Timeout"
    }
  ],
  "_request_id": "abcd-1234"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Version Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

Loading...