Get a HTTP server profile
GET/http-server-profiles/:id
Get an existing HTTP server profile.
Request
Path Parameters
The UUID of the configuration resource
Responses
- 200
- 400
- 401
- 403
- 404
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
- folder
- snippet
- device
- Array [
- ]
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
- Array [
- ]
- Array [
- ]
receive_time
serial
seqno
actionflags
type
subtype
time_generated
high_res_timestamp
dg_hier_level_1
dg_hier_level_2
dg_hier_level_3
dg_hier_level_4
vsys_name
device_name
vsys_id
host
vsys
cmd
admin
client
result
path
dg_id
comment
tpl_id
sender_sw_version
cef-formatted-receive_time
cef-formatted-time_generated
before-change-detail
after-change-detail
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
The folder in which the resource is defined
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
The snippet in which the resource is defined
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
The device in which the resource is defined
The UUID of the HTTP server profile
Possible values: <= 63 characters
The name of the profile
server object[]
HTTP server name
HTTP server address
Possible values: [HTTP
, HTTPS
]
HTTP server protocol
Possible values: <= 65535
HTTP server port
Possible values: [1.0
, 1.1
, 1.2
, 1.3
]
HTTP server TLS version
Default value: None
HTTP server certificate profile
Possible values: [GET
, POST
, PUT
, DELETE
]
HTTP operation to perform
Register tags on match
format object
config object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
system object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
traffic object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
threat object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
wildfire object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
url object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
data object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
gtp object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
sctp object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
tunnel object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
auth object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
userid object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
iptag object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
decryption object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
globalprotect object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
hip_match object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
correlation object
Default value: Default
The name of the payload format
The URL path of the HTTP server
headers object[]
Header name
Header value
params object[]
Parameter name
Parameter value
The log payload format. The accepted log field values are as follows.
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"name": "string",
"server": [
{
"name": "string",
"address": "string",
"protocol": "HTTP",
"port": 0,
"tls_version": "1.0",
"certificate_profile": "None",
"http_method": "GET"
}
],
"tag_registration": true,
"format": {
"config": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"system": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"traffic": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"threat": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"wildfire": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"url": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"data": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"gtp": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"sctp": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"tunnel": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"auth": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"userid": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"iptag": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"decryption": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"globalprotect": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"hip_match": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
},
"correlation": {
"name": "Default",
"url_format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"params": [
{
"name": "string",
"value": "string"
}
],
"payload": "string"
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- input_format_mismatch
- output_format_mismatch
- missing_query_parameter
- invalid_query_parameter
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E003",
"message": "Input Format Mismatch: input-format=json",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Output Format Mismatch: output-format=json Accept=xml",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Missing Query Parameter: name",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_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[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E016",
"message": "Not Authenticated",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "Invalid Credential",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "Key Too Long",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E016",
"message": "Key Expired",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_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[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_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[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_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[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
{
"_errors": [
{
"code": "E012",
"message": "Version Not Supported",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E012",
"message": "Method Not Supported",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E012",
"message": "Action Not Supported: move",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E013",
"message": "Bad XPath",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Invalid Command",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "E003",
"message": "Malformed Command",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
{
"_errors": [
{
"code": "4",
"message": "Session Timeout",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}