Create a HTTP server profile

POST 
/http-server-profiles

Create a new HTTP server profile.

Request

application/json

Body

Created

oneOf

folder

folder stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The folder in which the resource is defined

snippet

snippet stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The snippet in which the resource is defined

device

device stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The device in which the resource is defined

name string

Possible values: <= 63 characters

The name of the profile

server object[]
Array [
name string
HTTP server name
address string
HTTP server address
protocol string
Possible values: [HTTP, HTTPS]
HTTP server protocol
port integer
Possible values: <= 65535
HTTP server port
tls_version string
Possible values: [1.0, 1.1, 1.2, 1.3]
HTTP server TLS version
certificate_profile string
Default value: None
HTTP server certificate profile
http_method string
Possible values: [GET, POST, PUT, DELETE]
HTTP operation to perform
]
tag_registration boolean

Register tags on match

format object
config object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
system object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
traffic object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
threat object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
wildfire object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
url object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
data object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
gtp object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
sctp object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
tunnel object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
auth object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
userid object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
iptag object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
decryption object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
globalprotect object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
hip_match object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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
correlation object
name string
Default value: Default
The name of the payload format
url_format string
The URL path of the HTTP server
headers object[]
Array [
name string
Header name
value string
Header value
]
params object[]
Array [
name string
Parameter name
value string
Parameter value
]
payload string
The log payload format. The accepted log field values are as follows.
• 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

Responses

201

Created

400

Bad Request

application/json

Schema

Schema

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

Example (from schema)

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

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

output_format_mismatch

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

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

missing_body

Missing Body

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Body",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_object

Invalid Object

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Object",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

401

Unauthorized

application/json

Schema

Schema

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

Example (from schema)

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

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

403

Forbidden

application/json

Schema

Schema

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

Example (from schema)

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

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

409

Conflict

application/json

Schema

Schema

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

Example (from schema)

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

object_not_unique

Object Not Unique

{
  "_errors": [
    {
      "code": "E016",
      "message": "Object Not Unique",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

name_not_unique

Name Not Unique

{
  "_errors": [
    {
      "code": "E006",
      "message": "Name Not Unique",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

reference_not_zero

Reference Not Zero

{
  "_errors": [
    {
      "code": "E009",
      "message": "Reference Not Zero",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

default

General Errors

application/json

Schema

Schema

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

Example (from schema)

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

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Loading...