Retrieve the full configuration details of a VPN 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 Windows VPN Policy payload details

Request URL

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

connection_namestring

Connection Name. Default: VPN Configuration

connection_typeinteger

Connection Type. Default: 0

send_all_nw_trafficboolean

Send All Nw Traffic. Default: false

enable_vpn_on_demandboolean

Enable Vpn On Demand. Default: false

l2tpJSON Object

L2Tp

Show Sub-Attributes
pptpJSON Object

Pptp

Show Sub-Attributes
customsslJSON Object

Customssl

Show Sub-Attributes
ikev2JSON Object

Ikev2

Show Sub-Attributes
proxy_typeinteger

Proxy Type. Default: 0

proxy_serverstring

Proxy Server

proxy_server_portinteger

Proxy Server Port. Default: 0

proxy_user_namestring

Proxy User Name

proxy_pac_urlstring

Proxy Pac Url

vpn_typeinteger

Vpn Type. Default: 1

provider_typeinteger

Provider Type. Default: 1

vpnuuidstring

Vpnuuid

allowed_appsarray

Allowed Apps

custom_dataarray

Custom Data

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of VPN payload item

Copied!
  {
    "provider_type": "1",
    "payload_id": "9007199254741295",
    "connection_type": "6",
    "proxy_user_name": "",
    "proxy_server": "127.0.0.1",
    "allowed_apps": [
      {
        "group_display_name": "Alarms and clock",
        "is_system_app": false,
        "app_id": "1"
      }
    ],
    "enable_vpn_on_demand": false,
    "vpnuuid": "",
    "proxy_server_port": "3128",
    "vpn_type": "2",
    "connection_name": "VPN Configuration",
    "send_all_nw_traffic": false,
    "customssl": {
      "certificate_id": "-1",
      "identifier": "951D7986.PulseSecureVPN_qzpvqh70t9a4p",
      "server_name": "127.0.0.1",
      "user_authentication": "0",
      "provider_identifier": "",
      "account": ""
    },
    "proxy_pac_url": "",
    "custom_data": [
      {
        "custom_value": "1",
        "custom_key": "preferredRealm"
      },
      {
        "custom_value": "true",
        "custom_key": "optimizeForLowCostNetwork"
      },
      {
        "custom_value": "1",
        "custom_key": "preferredRole"
      },
      {
        "custom_value": "true",
        "custom_key": "isSingleSignOnCredential"
      }
    ],
    "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.