Zone Templates
Get
URL/api/v1/api.php?target=zoneTemplate&action=get
DescriptionReturns success or failure of a connection to an external server via SSH.
Returns

Examples:

SUCCESSFUL{"success":1,"message":"Found 1 records for template \"Awesome Template\".","data":{"templateId":"1011","name":"Awesome Template","created":"2013-07-31 14:01:24","modified":"2013-07-31 14:01:24","userId":"112","soa":null,"refresh":"14400","retry":"3600","expire":"604800","minimum":null,"ttl":null,"userName":"joe@smith.com","records":[{"templateRecordId":"4","templateId":"1011","host":"www","type":"A","ttl":"3600","value":"1.2.3.4","ordering":"0"}]}}
ERROR{'success':0, 'message':'error message'}
Required Parameters

None

Optional Parameters
Name
Type
Example
Description
templateIdNUMBER3ID of the specific template to get.
    
Example URL/api/v1/api.php?target=auth&action=testSSH&username=jsmith&password=password123&directory=%2Fvar%2Fnamed%2F6connect%2Fqa4&SSHPort=22

 

Create
URL/api/v1/api.php?target=auth&action=testSSH
DescriptionTest basic connectivity to an LDAP server. Does not test actual authenticaion against server.
ReturnsExamples:
SUCCESSFUL: {'success':1, 'id':'12345'}
ERROR: {'success':0, 'message':'unable to add block'}>
Required Parameters
Name
Type
Example
Description
ldapServerSTRINGldap.awesome.comIP or FQDN of the LDAP server.
ldapPortNUMBER 389User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name
ldapModeSTRING SSLOptions are: SSL, TLS, or None.
Optional Parameters

None

Example URL/api/v1/api.php?target=auth&action=testLDAP&ldapPort=389&ldapServer=ldap.awesome.com&ldapMode=None

 

Update
URL/api/v1/api.php?target=auth&action=testSecure64
DescriptionReturns success or failure of a connection to an Secure64 DNS appliance.
Returns

Examples:

SUCCESSFUL{"success":1,"message":"Success!"}
ERROR{'success':0, 'message':'error message'}
Required Parameters
Name
Type
Example
Description
SSHServerSTRINGtotally.awesome.comIP or FQDN of server.
SSHPortNUMBER22Port ssh is running on.
Optional Parameters
Name
Type
Example
Description
usernameSTRINGjsmithUsername on target server.
passwordSTRINGpassword123Password for user.
directorySTRING /tmpDirectory to attempt to access after successful login.
    
Example URL/api/v1/api.php?target=auth&action=testSecure64&username=jsmith&password=password123&directory=%2Fvar%2Fnamed%2F6connect%2Fqa4&SSHPort=22
Delete
URL/api/v1/api.php?target=auth&action=testSecure64
DescriptionReturns success or failure of a connection to an Secure64 DNS appliance.
Returns

Examples:

SUCCESSFUL{"success":1,"message":"Success!"}
ERROR{'success':0, 'message':'error message'}
Required Parameters
Name
Type
Example
Description
SSHServerSTRINGtotally.awesome.comIP or FQDN of server.
SSHPortNUMBER22Port ssh is running on.
Optional Parameters
Name
Type
Example
Description
usernameSTRINGjsmithUsername on target server.
passwordSTRINGpassword123Password for user.
directorySTRING /tmpDirectory to attempt to access after successful login.
    
Example URL/api/v1/api.php?target=auth&action=testSecure64&username=jsmith&password=password123&directory=%2Fvar%2Fnamed%2F6connect%2Fqa4&SSHPort=22