Understanding How The API Works »
Updating zone access permissions for a user via the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
REST Syntax
Click to view all REST Resources |
UserZoneEntry/ PUT — Replaces the list of zones where the user has access permission with a new list.
HTTP Action — PUT
URI — https://api.dynect.net/REST/UserZoneEntry/<user_name>/
|
Arguments — Click for More Info
- array
zone — Replacement list zones where the user will now have permissions. Pass an empty list or omit the argument to clear the user’s zone permissions.
- string
zone_name — Required. The name of the zone or FQDN where the permissions should apply.
- string
recurse — Indicates whether or not permissions should apply to subnodes of the zone_name as well.
Valid values:
Y – Permissions should apply to zone_name and any nodes below zone_name . Default.
N – Permissions should apply only to zone_name .
|
Response:
Not Applicable.
|
SOAP Syntax
Click to view all SOAP Commands |
SetUserZones — Replaces the list of zones where the user has access permission with a new list.
|
Arguments — Click for More Info
- string
user_name — Required. The user’s name.
- array
zone — Replacement list of zones where the user will now have permissions. If empty or not passed in, the user’s zone permissions will be cleared.
- string
zone_name — Required. The name of the zone or FQDN where the permissions update applies.
- string
recurse — Indicates whether or not the permission updates should apply to subnodes of the zone_name as well.
Valid values:
Y – Permissions should apply to zone_name and any nodes below zone_name . Default.
N – Permissions should apply only to zone_name .
- string
token — Required. The session identifier.
|
Response:
Not Applicable.
|
Example Request — Click for More Info
{
'token' => 'asdlj34ot879834cdzjklfK',
'user_name' => 'user1',
'zone' => [
{
'zone_name' => 'test.com',
}, {
'zone_name' => 'test2.com',
'recurse' => 'N'
},
]
}
|
DNS API Knowledge Base