Retrieve the full configuration details of a Firewall payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Tp get Mac Firewall policy payload item

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/macfirewallpolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macfirewallpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

enable_firewallstring

Whether the macOS application firewall is enabled. Values: 0=Disabled, 1=Enabled

block_all_incomingstring

Whether all incoming connections are blocked. Values: 0=Disabled, 1=Enabled, 2=User Controlled

enable_stealth_modestring

Whether stealth mode is enabled. Values: 0=Disabled, 1=Enabled, 2=User Controlled

allow_signed_appstring

Whether downloaded signed software is allowed incoming connections. Values: 0=Block, 1=Allow, 2=User Controlled

allow_signedstring

Whether built-in signed software is allowed incoming connections. Values: 0=Block, 1=Allow, 2=User Controlled

enable_loggingstring

Whether firewall logging is enabled. Values: 0=Disabled, 1=Enabled

logging_optionstring

Firewall logging detail level. Values: 0=Throttled, 1=Brief, 2=Detail

restricted_appsJSON Array

List of app-specific firewall rules with resolved app details

Show Sub-Attributes
JSON Object
Show Sub-Attributes
app_group_idlong

App group ID of the application

app_namestring

Display name of the application

bundle_idstring

Bundle identifier of the application

allow_incoming_connectionstring

Whether incoming connections are allowed. Values: 0=Blocked, 1=Allowed

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Firewall payload item

Copied!
  {
    "enable_stealth_mode": "2",
    "payload_id": 6967000001030034,
    "allow_signed_app": "1",
    "block_all_incoming": "2",
    "allow_signed": "1",
    "enable_firewall": "1",
    "restricted_apps": [
      {
        "app_name": "Calculator",
        "allow_incoming_connection": "0",
        "bundle_id": "com.apple.calculator",
        "app_group_id": 6967000000047041
      }
    ]
  }
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.