TCPWave RestAPI Store

This operation creates a new ACL in the TCPWave IPAM. This list controls DNS behavior when applied to the Allow-Notify, Allow-Query, Allow-Transfer, etc. If TCPWave IPAM does not manage the object(s) or subnet(s), or network(s), then the system restricts from creating the ACL.
Sample payload with mandatory parameters to add an ACL is listed below.
{"aclElementList":[{"exclude":0,"value":"10.2.3.5"}],"name":"test-client"}

Obtains the list of Access Control List(ACL) defined and managed by the TCPWave IPAM that do not have mask length in the value which are used to control the behavior of DNS when applied to the also-notify.
The example listed below shows a sample request URL:
/tims/rest/acls/customACLlist

This operation retrieves the details of specified ACLs defined and managed by the TCPWave IPAM, which controls DNS behavior when applied to the Allow-Notify, Allow-Query, Allow-Transfer, etc.
Example:
/tims/rest/acls/get?name=acl

Provides the list references of ACL in Option Templates, Zone Templates and AD enabled Zones in the TCPWave IPAM which use specified Access Control List(ACL)
The example listed below shows a sample request URL:
/tims/rest/acls/getreferences?name=acl

This operation retrieves the list of ACLs defined and managed by the TCPWave IPAM, which controls DNS behavior when applied to the Allow-Notify, Allow-Query, Allow-Transfer, etc.
Example:
/rest/acls/list?page=1&rows=20

Deletes multiple existing Access Control Lists(ACLs) from the TCPWave IPAM data repository. This action is audited.
Below example shows sample request JSON: ["test-client"]

This operation updates an existing ACL in the TCPWave IPAM. If the TCPWave IPAM does not manage the object(s) or subnet(s), or network(s), then the system restricts from updating the ACL..
Example:
{"name":"test-client","newName":"new-test-client","description":"ACL added to the TCPWave IPAM by Professional Services","aclElementList":[{"value":"10.24.6.8","sequence":"1","exclude":"0"},{"value":"10.24.6.9","sequence":"2","exclude":"0"},{"value":"10.24.11.9","sequence":"3","exclude":"0"},{"value":"10.24.15.8","sequence":"4","exclude":"0"},{"value":"10.1.1.1","sequence":"5","exclude":"0"},{"refAclName":"localnets","sequence":"6","exclude":"0"}]}

Validates authentication between the TCPWave DNS and Active Directory Domain Services (AD DS) using Kerberos authentication to use the interoperability features provided by the Kerberos Key Distribution Center (KDC) service.
Below example shows sample request JSON:
{"service_type":"DNS","principal_name":"DEV-DNSROOT-AUTH-001.plab.tcpwave.com","principal_type":"KRB5_NT_PRINCIPAL","realm":"TCPWAVE.COM","dnsIp":"10.1.10.187","encryption_type":"RC4-HMAC-NT","dc_ip":"10.1.10.170"}

Removes mapping of existing Active Directory Domain Services (AD DS) User Principal Name (UPN) from the TCPWave IPAM. Below is the example
[{
"dnsIp": "192.168.0.215",
"encryption_type": "RC4-HMAC-NT",
"id": 8,
"principal_name": "TCPWave00001Remote.domain.com",
"principal_type": "KRB5_NT_PRINCIPAL",
"realm": "DOMAIN.COM",
"service_type": "LOCAL"
}]

Deletes the keytab principals from the Authoritative DNS Appliance.

Obtains the details of Kerberos configuration from the Authoritative DNS Appliance.

Creates a mapping of existing Active Directory Domain Services (AD DS) to User Principal Name (UPN) into the TCPWave IPAM. A UPN is the name of a system user in an e-mail address format.Example: username@user.associated.internet.domain.
Below example shows sample request JSON:
{"dc_ip":"10.1.2.3","dnsDomainName":"test.tcpwave.net","dnsIp":"10.1.2.4","dnsServerName":"server1","encryption_type":"RC4-HMAC-NT","file_data":"File Data","file_name":"filename","principal_name":""server1@domain.com","principal_type":"KRB5_NT_PRINCIPAL","realm":"TCPWAVE.COM","service_type":"ServerType""}

Obtains a list of Active Directory Domain Services (AD DS) User Principal Name (UPN) which Obtains a List of all permissions associated with a given admin group. Functional Admin can list the permissions of any admin group. Rest of the Admins are restricted to the admin groups that belong to their organization. A UPN is the name of a system user in an e-mail address format. Example: username@user.associated.internet.domain.

This operation creates a new admin group. Functional and User admins have the privilege to create admin groups in any organization. The super admins can create only in the organization that they belong.
Example:
{ "*name":"QA Admin group", "*description":"Admin group" "*addedRoles":[{ "*organization_name":"Internal", "*name":"SADM"}] }

This operation deletes an existing admin group. Functional and User admins have the privilege to delete an admin group belonging to any organization.
Example:
/rest/admingroup/delete?name=adminGroupName

This operation retrieves the details of the given admin group.
Example:
/rest/admingroup/get?admin_group_name=testAdmin

This operation displays the list of all admin groups defined and managed by the TCPWave IPAM.
Example:
/rest/admingroup/list?page=1&rows=20

This operation displays the list of all admin groups defined and managed by the TCPWave IPAM.
The following example shows a sample request URL:
/tims/rest/admingroup/list/admin

This operation retrieves the list of admin roles associated with the given admin group(s).
The following example shows a sample request URL:
/rest/admingroup/list/adminroles?adminroles=1

This operation retrieves the list of associated organizations with the given admin group(s).
The following example shows a sample request URL:
/tims/rest/admingroup/list/org?group_id=1

This operation retrieves the list of roles associated with the given admin group .
The following example shows a sample request URL:
/tims/rest/admingroup/list/selectedroles?group_name=groupName

This operation updates an existing admin group. Functional and User admins have the privilege to edit an admin group belonging to any organization.
Example:
{ "*name":"QA Admin group2", "description":"Admin group" "*addedRoles":[{ "*organization_name":"Internal", "*name":"TestRole2"}] "*oldName":"QA Admin group", "*deletedRoles":[{ "*organization_name":"Internal", "*name":"TestRole1"}] }

Delete the specified grid preferences.

Delete the specified admin preferences.

Get the details of the specified admin preferences.
The example listed below shows a sample request URL:
/rest/preference/get

Creates a new administrator role in the TCPWave IPAM.
Below example shows sample request JSON:
{"name":"roleName","description":"new desc""addedFunctions":[{"name":"Quick Tasks"},{"name":"Appliance Groups"}]}

Deletes the Administrator role present in the TCPWave IPAM. Functional Admin and User Admins can delete an Appliance group in any organization. Other Admins can delete the Appliance groups belonging to their organization only.
The example listed below shows a sample request URL:
/rest/adminrole/delete?name=roleName

Get the details of the Administrator role defined in the TCPWave IPAM.
The example listed below shows a sample request URL:
/rest/adminroles/get?name=roleName

Provides a list of Administrator roles present in the TCPWave IPAM.
The example listed below shows a sample request URL:
/rest/adminroles/list?start=1&length=20

Provides a list of functions present in the TCPWave IPAM.
The example listed below shows a sample request URL:
/rest/adminroles/listfunctions?start=1&length=20

Obtains a list of functions corresponding to a given role in the TCPWave IPAM
The example listed below shows a sample request URL:
/rest/adminroles/listfunctionsdata?create=YES&default_role=TRUE

Obtains a list of Administrator Role names in the TCPWave IPAM
The example listed below shows a sample request URL:
/rest/adminroles/listroles

List all the admin roles. Lists all the possible Admin Roles in the system.
The example listed below shows a sample request URL:
rest/adminroles/roles/list

List all the functions list for selected administrator roles .
The example listed below shows a sample request URL:
/rest/adminroles/selectedfunctions?role_name=SADM