Versions Compared

Old Version 2

changes.mady.by.user Unknown User (anna)

Saved on

compared with

New Version Current

changes.mady.by.user The Force

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 8.0.0

Table of Contents

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=authzoneTemplate&action=testSSH&username=jsmith&password=password123&directory=%2Fvar%2Fnamed%2F6connect%2Fqa4&SSHPort=22get

 

Create

Update

URL/api/v1/api.php?target=authzoneTemplate&action=testSSHupdate
DescriptionTest basic connectivity to an LDAP server. Does not test actual authenticaion against serverCreate a new template or update an existing template.
ReturnsExamples:
SUCCESSFUL: {'"success':1, 'id':'12345'":1,"message":"Template updated","data":{"templateId":"1011","name":"Awesome Template","created":"2013-08-05 23:15:52","modified":"2013-08-05 23:15:52","userId":"112","soa":"ns1.test.net hostmaster.ns1.test.net","refresh":"14400","retry":"3600","expire":"604800","minimum":null,"ttl":false,"userName":"anna@6connect.com","records":"1"}}
ERROR: {'success':0, 'message':'unable to add blockError updating template: error details'}>
Required Parameters


Name
Type
Example
Description
ldapServernameSTRINGldap.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

 

Test TemplateThe name of the template to be created or updated.





Optional Parameters


Name
Type
Example
Description
soaSTRINGns1.test.net hostmaster.ns1.test.netA valid SOA for the template in for format
ttl INTEGER 86400 The TTL for the zone template, which is the default expiration time for all records without their own TTL.
refresh INTEGER 14400 The time period for slaves to refresh the zone.
retry INTEGER 3600 Time that a slave should retry refreshing the zone in case of incident.
expire INTEGER604800 Time for a slave to expire a zone.
mininum INTEGER 3600 The maximum caching time in the event of failed lookups.
count_recordsINTEGER5Number of host records submitted with the update. All the following parameters names should be followed with their position in the count. In this example, the first record would have all the parameters for the first record followed by _1, the second record _2, and so on. This will be the order all records in the template follow.
host_1STRING
The DNS record value.
ttl_1INTEGER3600TTL of the specific host record.
type_1STRINGAA valid DNS record type.
value_1IP1.2.3.4A valid IPv4 or IPv6 address.


Example URL
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

zoneTemplate&action=update&templateId=1011&count_records=1&name=Awesome+Template&soa=ns1.test.net+hostmaster.ns1.test.net

&refresh=14400&retry=3600&expire=604800&minimum=3600&value_0=undefined+undefined&host_1=www&ttl_1=3600&type_1=A&value_1=1.2.3.4

 

Delete

URL/api/v1/api.php?target=authzoneTemplate&action=testSecure64delete
DescriptionReturns success or failure of a connection to an Secure64 DNS applianceDeletes a DNS template.
Returns

Examples:

SUCCESSFUL
{"success":1,"message":
"Success!
"Template \"Test Template\" delete."}
ERROR{'"success'":0, '"message':'error message'":"No template found for templateId \"1005\"."}


Required Parameters


Name
Type
Example
Description
SSHServertemplateIdSTRINGtotally.awesome.comIP or FQDN of server.INTEGER3ID of the template to deleteSSHPortNUMBER22Port 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.
    

None.


Example URL/api/v1/api.php?target=authzoneTemplate&action=testSecure64delete&username=jsmith&password=password123&directory=%2Fvar%2Fnamed%2F6connect%2Fqa4&SSHPort=22templateId=1005


Children Display