Modify the configuration of a Kiosk payload item within a profile

Modify Android VPN policy payload

Endpoints

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

Copy full URL

Request URL

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

connection_namestringMandatory

VPN connection display name (required)

connection_typeintegerMandatory

VPN connection protocol type. 1 = L2TP/IPSec PSK, 2 = L2TP/IPSec RSA, 3 = IPSec Xauth PSK, 4 = IPSec Xauth RSA, 5 = IPSec IKEv2 PSK, 6 = IPSec IKEv2 RSA, 7 = IPSec Hybrid RSA, 8 = PPTP, 19 = Cisco AnyConnect, 20 = Pulse Secure, 21 = F5 SSL, 22 = Palo Alto (required)

vpn_app_idJSON ObjectOptional

App identifier for the VPN client application

Show Sub-Attributes

group_display_namestringOptional

Display name of the app or app group

app_idlongOptional

Unique identifier of the app group

vpn_lockdown_excluded_appsJSON ArrayOptional

List of apps excluded from VPN lockdown

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestringOptional

Display name of the app or app group

app_idlongOptional

Unique identifier of the app group

always_onbooleanOptional

Whether VPN is always on. Default: false

lockdown_enabledbooleanOptional

Whether VPN lockdown is enabled (blocks traffic without VPN). Default: false

l2tp_pskJSON ObjectOptional

L2TP/IPSec PSK connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

shared_secretstringMandatory

IPSec pre-shared key (write-only, required)

l2tp_secretstringOptional

L2TP secret key (write-only)

is_l2tp_secret_enabledbooleanOptional

Whether the L2TP secret is enabled. Default: false

accountstringOptional

VPN account username

ipsec_identifierstringOptional

IPSec group identifier

passwordstringOptional

VPN authentication password (write-only)

user_authenticationintegerOptional

User authentication method

dns_serversstringOptional

DNS server addresses

forwarding_routesstringOptional

Forwarding routes for VPN traffic

user_certificate_idlongOptional

User certificate ID for RSA authentication

l2tp_rsaJSON ObjectOptional

L2TP/IPSec RSA connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

shared_secretstringMandatory

IPSec pre-shared key (write-only, required)

l2tp_secretstringOptional

L2TP secret key (write-only)

is_l2tp_secret_enabledbooleanOptional

Whether the L2TP secret is enabled. Default: false

accountstringOptional

VPN account username

ipsec_identifierstringOptional

IPSec group identifier

passwordstringOptional

VPN authentication password (write-only)

user_authenticationintegerOptional

User authentication method

dns_serversstringOptional

DNS server addresses

forwarding_routesstringOptional

Forwarding routes for VPN traffic

user_certificate_idlongOptional

User certificate ID for RSA authentication

pptpJSON ObjectOptional

PPTP connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

accountstringOptional

VPN account username

passwordstringOptional

VPN authentication password (write-only)

ipsec_xauth_pskJSON ObjectOptional

IPSec Xauth PSK connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

shared_secretstringMandatory

IPSec pre-shared key (write-only, required)

accountstringOptional

VPN account username

ipsec_identifierstringOptional

IPSec group identifier

passwordstringOptional

VPN authentication password (write-only)

dns_serversstringOptional

DNS server addresses

forwarding_routesstringOptional

Forwarding routes for VPN traffic

ipsec_xauth_rsaJSON ObjectOptional

IPSec Xauth RSA connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

shared_secretstringMandatory

IPSec pre-shared key (write-only, required)

accountstringOptional

VPN account username

ipsec_identifierstringOptional

IPSec group identifier

passwordstringOptional

VPN authentication password (write-only)

dns_serversstringOptional

DNS server addresses

forwarding_routesstringOptional

Forwarding routes for VPN traffic

ipsec_ikev2_pskJSON ObjectOptional

IPSec IKEv2 PSK connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

shared_secretstringMandatory

IPSec pre-shared key (write-only, required)

accountstringOptional

VPN account username

ipsec_identifierstringOptional

IPSec group identifier

passwordstringOptional

VPN authentication password (write-only)

dns_serversstringOptional

DNS server addresses

forwarding_routesstringOptional

Forwarding routes for VPN traffic

ipsec_ikev2_rsaJSON ObjectOptional

IPSec IKEv2 RSA connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

shared_secretstringMandatory

IPSec pre-shared key (write-only, required)

accountstringOptional

VPN account username

ipsec_identifierstringOptional

IPSec group identifier

passwordstringOptional

VPN authentication password (write-only)

dns_serversstringOptional

DNS server addresses

forwarding_routesstringOptional

Forwarding routes for VPN traffic

ipsec_hybrid_rdaJSON ObjectOptional

IPSec Hybrid RSA connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

shared_secretstringMandatory

IPSec pre-shared key (write-only, required)

accountstringOptional

VPN account username

ipsec_identifierstringOptional

IPSec group identifier

passwordstringOptional

VPN authentication password (write-only)

dns_serversstringOptional

DNS server addresses

forwarding_routesstringOptional

Forwarding routes for VPN traffic

pulsesecureJSON ObjectOptional

Pulse Secure VPN connection configuration

Show Sub-Attributes

auth_typestringOptional

Authentication type

certificate_idlongOptional

Client certificate ID

always_onbooleanOptional

Whether VPN is always on. Default: false

is_deafault_vpnbooleanOptional

Whether this is the default VPN connection. Default: false

app_vpn_actionstringOptional

Per-app VPN action

passwordstringOptional

VPN authentication password (write-only)

keychain_cert_aliasstringOptional

Keychain certificate alias

server_namestringMandatory

VPN server hostname or IP address (required)

route_typestringOptional

VPN route type

realmstringOptional

Authentication realm

accountstringOptional

VPN account username

rolestringOptional

User role

uiless_authbooleanOptional

Whether UI-less authentication is used. Default: false

allowed_appsstringOptional

Comma-separated package names of apps allowed through VPN

user_authenticationintegerOptional

User authentication method

f5sslJSON ObjectOptional

F5 SSL VPN connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

web_logon_modebooleanOptional

Whether web logon mode is used. Default: false

user_messagestringOptional

User-facing message displayed during VPN connection

allowed_appsstringOptional

Comma-separated package names of apps allowed through VPN

certificate_idlongOptional

Client certificate ID

fips_modebooleanOptional

Whether FIPS mode is enabled. Default: false

accountstringOptional

VPN account username

disallow_user_configbooleanOptional

Whether user configuration changes are disallowed. Default: false

passwordstringOptional

VPN authentication password (write-only)

keychain_cert_aliasstringOptional

Keychain certificate alias

user_authenticationintegerOptional

User authentication method

ciscoanyconnectJSON ObjectOptional

Cisco AnyConnect VPN connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

cert_revocationbooleanOptional

Whether certificate revocation checking is enabled. Default: false

ipsec_auth_typestringOptional

IPSec authentication type

certificate_idlongOptional

Client certificate ID

always_onbooleanOptional

Whether VPN is always on. Default: false

fips_modebooleanOptional

Whether FIPS mode is enabled. Default: false

vpn_connection_protocolstringOptional

VPN connection protocol (SSL or IPSec)

strict_modebooleanOptional

Whether strict certificate validation is enabled. Default: false

passwordstringOptional

VPN authentication password (write-only)

ike_identitystringOptional

IKE identity string

keychain_cert_aliasstringOptional

Keychain certificate alias

allowed_appsstringOptional

Comma-separated package names of apps allowed through VPN

user_authenticationintegerOptional

User authentication method

paloaltoJSON ObjectOptional

Palo Alto Networks GlobalProtect VPN connection configuration

Show Sub-Attributes

server_namestringMandatory

VPN server hostname or IP address (required)

certificate_idlongOptional

Client certificate ID

accountstringOptional

VPN account username

passwordstringOptional

VPN authentication password (write-only)

keychain_cert_aliasstringOptional

Keychain certificate alias

allowed_appsstringOptional

Comma-separated package names of apps allowed through VPN

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidvpnpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"connection_name":"VPN Configuration","lockdown_enabled":false,"connection_type":19,"vpn_app_id":{},"l2tp_psk":{},"vpn_lockdown_excluded_apps":[],"ipsec_xauth_psk":{},"always_on":false,"pptp":{},"l2tp_rsa":{}}'

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/androidvpnpolicy/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"connection_name\":\"VPN Configuration\",\"lockdown_enabled\":false,\"connection_type\":19,\"vpn_app_id\":{},\"l2tp_psk\":{},\"vpn_lockdown_excluded_apps\":[],\"ipsec_xauth_psk\":{},\"always_on\":false,\"pptp\":{},\"l2tp_rsa\":{}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"connection_name\":\"VPN Configuration\",\"lockdown_enabled\":false,\"connection_type\":19,\"vpn_app_id\":{},\"l2tp_psk\":{},\"vpn_lockdown_excluded_apps\":[],\"ipsec_xauth_psk\":{},\"always_on\":false,\"pptp\":{},\"l2tp_rsa\":{}}"

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

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/androidvpnpolicy/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("connection_name","value");
    data.put("connection_type","1");
    data_vpn_app_id=Map();
    data_vpn_app_id.put("group_display_name","value");
    data_vpn_app_id.put("app_id","1");
    data.put("vpn_app_id",data_vpn_app_id);
    data_vpn_lockdown_excluded_apps=List();
    data_vpn_lockdown_excluded_apps_item1=Map();
    data_vpn_lockdown_excluded_apps_item1.put("group_display_name","value");
    data_vpn_lockdown_excluded_apps_item1.put("app_id","1");
    data_vpn_lockdown_excluded_apps.add(data_vpn_lockdown_excluded_apps_item1);
    data.put("vpn_lockdown_excluded_apps",data_vpn_lockdown_excluded_apps);
    data.put("always_on",true);
    data.put("lockdown_enabled",true);
    data_l2tp_psk=Map();
    data_l2tp_psk.put("server_name","value");
    data_l2tp_psk.put("shared_secret","value");
    data_l2tp_psk.put("l2tp_secret","value");
    data_l2tp_psk.put("is_l2tp_secret_enabled",true);
    data_l2tp_psk.put("account","value");
    data_l2tp_psk.put("ipsec_identifier","value");
    data_l2tp_psk.put("password","value");
    data_l2tp_psk.put("user_authentication","1");
    data_l2tp_psk.put("dns_servers","value");
    data_l2tp_psk.put("forwarding_routes","value");
    data_l2tp_psk.put("user_certificate_id","1");
    data.put("l2tp_psk",data_l2tp_psk);
    data_l2tp_rsa=Map();
    data_l2tp_rsa.put("server_name","value");
    data_l2tp_rsa.put("shared_secret","value");
    data_l2tp_rsa.put("l2tp_secret","value");
    data_l2tp_rsa.put("is_l2tp_secret_enabled",true);
    data_l2tp_rsa.put("account","value");
    data_l2tp_rsa.put("ipsec_identifier","value");
    data_l2tp_rsa.put("password","value");
    data_l2tp_rsa.put("user_authentication","1");
    data_l2tp_rsa.put("dns_servers","value");
    data_l2tp_rsa.put("forwarding_routes","value");
    data_l2tp_rsa.put("user_certificate_id","1");
    data.put("l2tp_rsa",data_l2tp_rsa);
    data_pptp=Map();
    data_pptp.put("server_name","value");
    data_pptp.put("account","value");
    data_pptp.put("password","value");
    data.put("pptp",data_pptp);
    data_ipsec_xauth_psk=Map();
    data_ipsec_xauth_psk.put("server_name","value");
    data_ipsec_xauth_psk.put("shared_secret","value");
    data_ipsec_xauth_psk.put("account","value");
    data_ipsec_xauth_psk.put("ipsec_identifier","value");
    data_ipsec_xauth_psk.put("password","value");
    data_ipsec_xauth_psk.put("dns_servers","value");
    data_ipsec_xauth_psk.put("forwarding_routes","value");
    data.put("ipsec_xauth_psk",data_ipsec_xauth_psk);
    data_ipsec_xauth_rsa=Map();
    data_ipsec_xauth_rsa.put("server_name","value");
    data_ipsec_xauth_rsa.put("shared_secret","value");
    data_ipsec_xauth_rsa.put("account","value");
    data_ipsec_xauth_rsa.put("ipsec_identifier","value");
    data_ipsec_xauth_rsa.put("password","value");
    data_ipsec_xauth_rsa.put("dns_servers","value");
    data_ipsec_xauth_rsa.put("forwarding_routes","value");
    data.put("ipsec_xauth_rsa",data_ipsec_xauth_rsa);
    data_ipsec_ikev2_psk=Map();
    data_ipsec_ikev2_psk.put("server_name","value");
    data_ipsec_ikev2_psk.put("shared_secret","value");
    data_ipsec_ikev2_psk.put("account","value");
    data_ipsec_ikev2_psk.put("ipsec_identifier","value");
    data_ipsec_ikev2_psk.put("password","value");
    data_ipsec_ikev2_psk.put("dns_servers","value");
    data_ipsec_ikev2_psk.put("forwarding_routes","value");
    data.put("ipsec_ikev2_psk",data_ipsec_ikev2_psk);
    data_ipsec_ikev2_rsa=Map();
    data_ipsec_ikev2_rsa.put("server_name","value");
    data_ipsec_ikev2_rsa.put("shared_secret","value");
    data_ipsec_ikev2_rsa.put("account","value");
    data_ipsec_ikev2_rsa.put("ipsec_identifier","value");
    data_ipsec_ikev2_rsa.put("password","value");
    data_ipsec_ikev2_rsa.put("dns_servers","value");
    data_ipsec_ikev2_rsa.put("forwarding_routes","value");
    data.put("ipsec_ikev2_rsa",data_ipsec_ikev2_rsa);
    data_ipsec_hybrid_rda=Map();
    data_ipsec_hybrid_rda.put("server_name","value");
    data_ipsec_hybrid_rda.put("shared_secret","value");
    data_ipsec_hybrid_rda.put("account","value");
    data_ipsec_hybrid_rda.put("ipsec_identifier","value");
    data_ipsec_hybrid_rda.put("password","value");
    data_ipsec_hybrid_rda.put("dns_servers","value");
    data_ipsec_hybrid_rda.put("forwarding_routes","value");
    data.put("ipsec_hybrid_rda",data_ipsec_hybrid_rda);
    data_pulsesecure=Map();
    data_pulsesecure.put("auth_type","value");
    data_pulsesecure.put("certificate_id","1");
    data_pulsesecure.put("always_on",true);
    data_pulsesecure.put("is_deafault_vpn",true);
    data_pulsesecure.put("app_vpn_action","value");
    data_pulsesecure.put("password","value");
    data_pulsesecure.put("keychain_cert_alias","value");
    data_pulsesecure.put("server_name","value");
    data_pulsesecure.put("route_type","value");
    data_pulsesecure.put("realm","value");
    data_pulsesecure.put("account","value");
    data_pulsesecure.put("role","value");
    data_pulsesecure.put("uiless_auth",true);
    data_pulsesecure.put("allowed_apps","value");
    data_pulsesecure.put("user_authentication","1");
    data.put("pulsesecure",data_pulsesecure);
    data_f5ssl=Map();
    data_f5ssl.put("server_name","value");
    data_f5ssl.put("web_logon_mode",true);
    data_f5ssl.put("user_message","value");
    data_f5ssl.put("allowed_apps","value");
    data_f5ssl.put("certificate_id","1");
    data_f5ssl.put("fips_mode",true);
    data_f5ssl.put("account","value");
    data_f5ssl.put("disallow_user_config",true);
    data_f5ssl.put("password","value");
    data_f5ssl.put("keychain_cert_alias","value");
    data_f5ssl.put("user_authentication","1");
    data.put("f5ssl",data_f5ssl);
    data_ciscoanyconnect=Map();
    data_ciscoanyconnect.put("server_name","value");
    data_ciscoanyconnect.put("cert_revocation",true);
    data_ciscoanyconnect.put("ipsec_auth_type","value");
    data_ciscoanyconnect.put("certificate_id","1");
    data_ciscoanyconnect.put("always_on",true);
    data_ciscoanyconnect.put("fips_mode",true);
    data_ciscoanyconnect.put("vpn_connection_protocol","value");
    data_ciscoanyconnect.put("strict_mode",true);
    data_ciscoanyconnect.put("password","value");
    data_ciscoanyconnect.put("ike_identity","value");
    data_ciscoanyconnect.put("keychain_cert_alias","value");
    data_ciscoanyconnect.put("allowed_apps","value");
    data_ciscoanyconnect.put("user_authentication","1");
    data.put("ciscoanyconnect",data_ciscoanyconnect);
    data_paloalto=Map();
    data_paloalto.put("server_name","value");
    data_paloalto.put("certificate_id","1");
    data_paloalto.put("account","value");
    data_paloalto.put("password","value");
    data_paloalto.put("keychain_cert_alias","value");
    data_paloalto.put("allowed_apps","value");
    data.put("paloalto",data_paloalto);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidvpnpolicy/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/androidvpnpolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"connection_name":"VPN Configuration","lockdown_enabled":false,"connection_type":19,"vpn_app_id":{},"l2tp_psk":{},"vpn_lockdown_excluded_apps":[],"ipsec_xauth_psk":{},"always_on":false,"pptp":{},"l2tp_rsa":{}}'

Sample Request Body

Modify VPN payload item

Copied!

  {
    "connection_name": "VPN Configuration",
    "lockdown_enabled": false,
    "connection_type": 19,
    "vpn_app_id": {},
    "l2tp_psk": {},
    "vpn_lockdown_excluded_apps": [],
    "ipsec_xauth_psk": {},
    "always_on": false,
    "pptp": {},
    "l2tp_rsa": {}
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

connection_namestring

VPN connection display name (required)

connection_typeinteger

vpn_app_idJSON Object

App identifier for the VPN client application

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

vpn_lockdown_excluded_appsJSON Array

List of apps excluded from VPN lockdown

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

always_onboolean

Whether VPN is always on. Default: false

lockdown_enabledboolean

Whether VPN lockdown is enabled (blocks traffic without VPN). Default: false

l2tp_pskJSON Object

L2TP/IPSec PSK connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

shared_secretstring

IPSec pre-shared key (write-only, required)

l2tp_secretstring

L2TP secret key (write-only)

is_l2tp_secret_enabledboolean

Whether the L2TP secret is enabled. Default: false

accountstring

VPN account username

ipsec_identifierstring

IPSec group identifier

passwordstring

VPN authentication password (write-only)

user_authenticationinteger

User authentication method

dns_serversstring

DNS server addresses

forwarding_routesstring

Forwarding routes for VPN traffic

user_certificate_idlong

User certificate ID for RSA authentication

l2tp_rsaJSON Object

L2TP/IPSec RSA connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

shared_secretstring

IPSec pre-shared key (write-only, required)

l2tp_secretstring

L2TP secret key (write-only)

is_l2tp_secret_enabledboolean

Whether the L2TP secret is enabled. Default: false

accountstring

VPN account username

ipsec_identifierstring

IPSec group identifier

passwordstring

VPN authentication password (write-only)

user_authenticationinteger

User authentication method

dns_serversstring

DNS server addresses

forwarding_routesstring

Forwarding routes for VPN traffic

user_certificate_idlong

User certificate ID for RSA authentication

pptpJSON Object

PPTP connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

accountstring

VPN account username

passwordstring

VPN authentication password (write-only)

ipsec_xauth_pskJSON Object

IPSec Xauth PSK connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

shared_secretstring

IPSec pre-shared key (write-only, required)

accountstring

VPN account username

ipsec_identifierstring

IPSec group identifier

passwordstring

VPN authentication password (write-only)

dns_serversstring

DNS server addresses

forwarding_routesstring

Forwarding routes for VPN traffic

ipsec_xauth_rsaJSON Object

IPSec Xauth RSA connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

shared_secretstring

IPSec pre-shared key (write-only, required)

accountstring

VPN account username

ipsec_identifierstring

IPSec group identifier

passwordstring

VPN authentication password (write-only)

dns_serversstring

DNS server addresses

forwarding_routesstring

Forwarding routes for VPN traffic

ipsec_ikev2_pskJSON Object

IPSec IKEv2 PSK connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

shared_secretstring

IPSec pre-shared key (write-only, required)

accountstring

VPN account username

ipsec_identifierstring

IPSec group identifier

passwordstring

VPN authentication password (write-only)

dns_serversstring

DNS server addresses

forwarding_routesstring

Forwarding routes for VPN traffic

ipsec_ikev2_rsaJSON Object

IPSec IKEv2 RSA connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

shared_secretstring

IPSec pre-shared key (write-only, required)

accountstring

VPN account username

ipsec_identifierstring

IPSec group identifier

passwordstring

VPN authentication password (write-only)

dns_serversstring

DNS server addresses

forwarding_routesstring

Forwarding routes for VPN traffic

ipsec_hybrid_rdaJSON Object

IPSec Hybrid RSA connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

shared_secretstring

IPSec pre-shared key (write-only, required)

accountstring

VPN account username

ipsec_identifierstring

IPSec group identifier

passwordstring

VPN authentication password (write-only)

dns_serversstring

DNS server addresses

forwarding_routesstring

Forwarding routes for VPN traffic

pulsesecureJSON Object

Pulse Secure VPN connection configuration

Show Sub-Attributes

auth_typestring

Authentication type

certificate_idlong

Client certificate ID

always_onboolean

Whether VPN is always on. Default: false

is_deafault_vpnboolean

Whether this is the default VPN connection. Default: false

app_vpn_actionstring

Per-app VPN action

passwordstring

VPN authentication password (write-only)

keychain_cert_aliasstring

Keychain certificate alias

server_namestring

VPN server hostname or IP address (required)

route_typestring

VPN route type

realmstring

Authentication realm

accountstring

VPN account username

rolestring

User role

uiless_authboolean

Whether UI-less authentication is used. Default: false

allowed_appsstring

Comma-separated package names of apps allowed through VPN

user_authenticationinteger

User authentication method

f5sslJSON Object

F5 SSL VPN connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

web_logon_modeboolean

Whether web logon mode is used. Default: false

user_messagestring

User-facing message displayed during VPN connection

allowed_appsstring

Comma-separated package names of apps allowed through VPN

certificate_idlong

Client certificate ID

fips_modeboolean

Whether FIPS mode is enabled. Default: false

accountstring

VPN account username

disallow_user_configboolean

Whether user configuration changes are disallowed. Default: false

passwordstring

VPN authentication password (write-only)

keychain_cert_aliasstring

Keychain certificate alias

user_authenticationinteger

User authentication method

ciscoanyconnectJSON Object

Cisco AnyConnect VPN connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

cert_revocationboolean

Whether certificate revocation checking is enabled. Default: false

ipsec_auth_typestring

IPSec authentication type

certificate_idlong

Client certificate ID

always_onboolean

Whether VPN is always on. Default: false

fips_modeboolean

Whether FIPS mode is enabled. Default: false

vpn_connection_protocolstring

VPN connection protocol (SSL or IPSec)

strict_modeboolean

Whether strict certificate validation is enabled. Default: false

passwordstring

VPN authentication password (write-only)

ike_identitystring

IKE identity string

keychain_cert_aliasstring

Keychain certificate alias

allowed_appsstring

Comma-separated package names of apps allowed through VPN

user_authenticationinteger

User authentication method

paloaltoJSON Object

Palo Alto Networks GlobalProtect VPN connection configuration

Show Sub-Attributes

server_namestring

VPN server hostname or IP address (required)

certificate_idlong

Client certificate ID

accountstring

VPN account username

passwordstring

VPN authentication password (write-only)

keychain_cert_aliasstring

Keychain certificate alias

allowed_appsstring

Comma-separated package names of apps allowed through VPN

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

VPN payload item successfully modified

Copied!

  {
    "connection_name": "VPN Configuration",
    "payload_id": 9007199254741000,
    "lockdown_enabled": false,
    "connection_type": 19,
    "vpn_app_id": {},
    "l2tp_psk": {},
    "vpn_lockdown_excluded_apps": [],
    "ipsec_xauth_psk": {},
    "always_on": false,
    "pptp": {},
    "l2tp_rsa": {}
  }

▼ 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.