Versions Compared

Old Version 1

changes.mady.by.user The Force

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 space DOC and version 7.4.0-7.4.6

Table of Contents

 Authentication Testing

testSSH

URL/api/v1/api.php?target=auth&action=testSSH
DescriptionReturns success or failure of a connection to an external server via SSH.
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=testSSH&username=jsmith&password=password123&directory=
%2Fvar%2Fnamed%2F6connect%2Fqa4
%2Fvar%2Fnamed%2Fexample%2Fqa4&SSHPort=22&SSHServer=myssh.awesome.com

 

testLDAP

URL/api/v1/api.php?target=auth&action=testLDAP
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

 

testSecure64

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
%2Fvar%2Fnamed%2Fexample%2Fqa4&SSHPort=22