Retrieve the full configuration details of a HTTP Proxy 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

Get Android HTTP Proxy payload

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/androidhttpproxypolicy/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/androidhttpproxypolicy/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

proxy_typeinteger

Proxy type. 1 = Manual proxy configuration, 2 = PAC file. Default: 1

proxy_serverstring

Hostname or IP address of the proxy server

proxy_server_portinteger

Port number for the proxy server connection. Default: 0

proxy_user_namestring

Username for proxy authentication

proxy_passwordstring

Password for proxy authentication (write-only; use proxy_password_id for credential ID reads)

proxy_password_idlong

ID of the saved password credential for proxy authentication

proxy_pac_urlstring

URL of the proxy auto-config (PAC) file (used when proxy_type=2)

bypass_proxy_urlstring

Semicolon-separated list of hostnames or IP addresses that bypass the proxy

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of HTTP Proxy payload item

Copied!
  {
    "payload_id": 9007199254741000,
    "proxy_user_name": "Zylker User",
    "proxy_server": "value",
    "proxy_password_id": 1,
    "proxy_password": "********",
    "proxy_pac_url": "https://zylker.com",
    "proxy_server_port": 0,
    "bypass_proxy_url": "https://zylker.com",
    "proxy_type": 1
  }
                
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.