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

To modify Mac Global Http Proxy policy payload item

Endpoints

put /api/v1/mdm/profiles/{profile_id}/payloads/macglobalhttpproxypolicy/payloaditems/{payload_id}

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/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

Hostname or IP address of the HTTP proxy server. Required when proxy_type is 1 (Manual)

proxy_server_portintegerOptional

Port number of the HTTP proxy server. Valid range: 0-65535. Default: 0

proxy_user_namestringOptional

Username for proxy server authentication

proxy_passwordstringOptional

Password for proxy server authentication (sensitive - write-only, not returned in responses)

proxy_password_idlongOptional

Internal identifier for the stored proxy password credential

proxy_pac_urlstringOptional

URL of the Proxy Auto-Configuration (PAC) file. Required when proxy_type is 2 (Automatic)

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macglobalhttpproxypolicy/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}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macglobalhttpproxypolicy/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"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}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"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}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/macglobalhttpproxypolicy/payloaditems/{payload_id}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("proxy_type","1");
    data.put("proxy_server","value");
    data.put("proxy_server_port","1");
    data.put("proxy_user_name","value");
    data.put("proxy_password","value");
    data.put("proxy_password_id","1");
    data.put("proxy_pac_url","value");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/macglobalhttpproxypolicy/payloaditems/{payload_id}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macglobalhttpproxypolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"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_typestring

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

proxy_serverstring

Hostname or IP address of the HTTP proxy server. Required when proxy_type is 1 (Manual)

proxy_server_portstring

Port number of the HTTP proxy server. Valid range: 0-65535. Default: 0

proxy_user_namestring

Username for proxy server authentication

proxy_passwordstring

Password for proxy server authentication (sensitive - write-only, not returned in responses)

proxy_password_idlong

Internal identifier for the stored proxy password credential

proxy_pac_urlstring

URL of the Proxy Auto-Configuration (PAC) file. Required when proxy_type is 2 (Automatic)

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.