Modify the configuration of a Global HTTP Proxy payload item within a profile

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

To modify Global Http proxy policy payload item

Request URL

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

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
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

- Request Body

application/json
JSON Object
Hide Sub-Attributes
proxy_typeintegerOptional

Proxy configuration type. Allowed values: 0=None, 1=Manual, 2=Automatic (PAC URL)

proxy_serverstringMandatory

Proxy Server

proxy_server_portintegerOptional

Proxy Server Port. Default: 0

proxy_user_namestringOptional

Proxy User Name

proxy_passwordstringOptional

Proxy Password (sensitive - write-only)

proxy_password_idlongOptional

Proxy Password Id

proxy_pac_urlstringOptional

Proxy Pac Url

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/globalhttpproxypolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"proxy_user_name":"Zylker User","proxy_server":"value","proxy_password_id":1,"proxy_password":"********","proxy_pac_url":"https://zylker.com","proxy_server_port":0,"proxy_type":1}'

Sample Request Body

Modify Global HTTP Proxy payload item

Copied!
  {
    "proxy_user_name": "Zylker User",
    "proxy_server": "value",
    "proxy_password_id": 1,
    "proxy_password": "********",
    "proxy_pac_url": "https://zylker.com",
    "proxy_server_port": 0,
    "proxy_type": 1
  }
                
Show full

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 configuration type. Allowed values: 0=None, 1=Manual, 2=Automatic (PAC URL)

proxy_serverstring

Proxy Server

proxy_server_portinteger

Proxy Server Port. Default: 0

proxy_user_namestring

Proxy User Name

proxy_passwordstring

Proxy Password (sensitive - write-only)

proxy_password_idlong

Proxy Password Id

proxy_pac_urlstring

Proxy Pac Url

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Global HTTP Proxy payload item successfully modified

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,
    "proxy_type": 1
  }
                
Show full

Duration: 1 minute | Threshold: 60 | 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.