List GlobalProtect tunnel settings
GET/tunnel-profiles
Retrieve a list of GlobalProtect tunnel settings
Request
Query Parameters
name string
The name of the configuration resource
folder anyrequired
The folder in which the resource is defined
limit number
Default value: 200
The maximum number of results per page
offset number
Default value: 0
The offset into the list of results returned
Responses
- 200
- 400
- 401
- 403
- 404
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- ]
- ]
data object[]
name stringrequired
Possible values: non-empty
and <= 31 characters
authentication_override object
accept_cookie object
cookie_lifetime object
lifetime_in_days number
Possible values: >= 1
and <= 365
lifetime_in_hours number
Possible values: >= 1
and <= 72
lifetime_in_minutes number
Possible values: >= 1
and <= 59
cookie_encrypt_decrypt_cert string
generate_cookie boolean
no_direct_access_to_local_network boolean
os undefined[]
Possible values: [Android
, Chrome
, IoT
, Linux
, Mac
, Windows
, WindowsUWP
, iOS
]
retrieve_framed_ip_address boolean
source_address object
ip_address string[]
region string[]
source_user string[]
split_tunneling object
access_route string[]
exclude_access_route string[]
exclude_applications string[]
exclude_domains object
list object[]
name string
ports number[]
Possible values: >= 1
and <= 65535
include_applications string[]
include_domains object
list object[]
name string
ports number[]
Possible values: >= 1
and <= 65535
limit number
Default value: 200
offset number
Default value: 0
total number
{
"data": [
{
"name": "string",
"authentication_override": {
"accept_cookie": {
"cookie_lifetime": {
"lifetime_in_days": 0,
"lifetime_in_hours": 0,
"lifetime_in_minutes": 0
},
"cookie_encrypt_decrypt_cert": "string",
"generate_cookie": true
}
},
"no_direct_access_to_local_network": true,
"os": [
null
],
"retrieve_framed_ip_address": true,
"source_address": {
"ip_address": [
"string"
],
"region": [
"string"
]
},
"source_user": [
"string"
],
"split_tunneling": {
"access_route": [
"string"
],
"exclude_access_route": [
"string"
],
"exclude_applications": [
"string"
],
"exclude_domains": {
"list": [
{
"name": "string",
"ports": [
0
]
}
]
},
"include_applications": [
"string"
],
"include_domains": {
"list": [
{
"name": "string",
"ports": [
0
]
}
]
}
}
}
],
"limit": 200,
"offset": 0,
"total": 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...