Skip to main content

VpnCredential Schema

Data structure for Vpn Credential objects.

Fields​

FieldTypeRequiredDescriptionNotes
commentsstringNo--
common_namestringNo-API field: common_name
disabledbooleanNo--
fqdnstringNo--
idintegerYes--
ip_addressstringNo-API field: ip_address
locationEntityReferenceNo--
managed_byEntityReferenceNo-API field: managed_by
namestringYes--
pre_shared_keystringNo-API field: pre_shared_key
pskstringNo--
typestringYes--
xauth_passwordstringNo-API field: xauth_password

Example​

{
"comments": "string",
"common_name": "string",
"disabled": true,
"fqdn": "string",
"id": 123,
"ip_address": "string",
"location": {
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
},
"managed_by": {
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
}
}
// ... more fields