1. Overview

These API Calls allow the user with the appropriate privileges to add a network to the TCPWave IPAM. The parameters, parameter types, and the data types of the REST call are shown below. Execution of below REST calls is audited by the TCPWave IPAM. Customers are advised to execute these REST API calls in a non production environment before attempting to execute in a production environment.

1.1. Version information

Version : 1.0.0

1.2. URI scheme

BasePath : /tims/rest
Schemes : HTTPS

1.3. Tags

  • Server Sync Status Service

  • Central Logging Service

  • Contact Service

  • DHCP Class Service

  • User Cert Service

  • DNS Tools Service

  • Class Code Service

  • Audit Logs and License Information

  • Bookmark Service

  • IPV6 Object Service

  • IPV6 Network Service

  • Scheduled Audit Report Service

  • File Upload Service

  • UndoData Service

  • IPV6 Scope Service

  • Class Code Logo Service

  • Server Service

  • Global Options Service

  • Database Service

  • User Service

  • DHCP Active Lease Service

  • Role Service

  • Heartbeat Message Service

  • IPAM Version Service

  • Log Category Service

  • Cloud DNS Provider Service

  • Active Directory Service

  • DNS Server Service

  • Acl Service

  • Authentication Type

  • Import Service

  • AML Service

  • Asset Service

  • IPV6 Template Service

  • Params Service

  • Import Cloud Service

  • Audit Report details

  • History Tab Service

  • Location Service

  • Authentication Token management

  • Message Certificate Magagement Service

  • Domain Service

  • IPV6 Subnet Group Service

  • Scope Service

  • Subnet Service

  • Monitor Service

  • Server License Service

  • Template Service

  • Timezone Service

  • Authorization Information

  • Home Service

  • RPZ Service

  • Checkouts Service Details

  • Admin Group Service

  • View Service

  • Zone Service

  • Scheduled Job Service

  • IPV6 DHCP Server Service

  • Internet Root Hints Service

  • Certificate Management Service

  • Network Service

  • Scheduled Job Executor Status Service

  • Firewall Service

  • IPV6 Subnet Service

  • Organization Service

  • Log Channel Service

  • Subnet Group Service

  • Switch Discovery Details Service

  • Search Service

  • Authentication Configuration Service

  • Audit Report Service

  • Discovery Service

  • Export Service

  • DHCP Server Service

  • Object Service

  • DNS Server Template Service

  • Algorithm Service

2. Authentication

The GUI and CLI users are subjected to authentication checks and their sessions are associated with the credentials that are used by the system to provide fine-grained authorization to various resources in the system. TIMS secures the access to the system from other tools using REST API directly by using long-lived security tokens for authentication and authorization. These tokens are associated with a client (Admin, and IP/Host), and credentials (Role). TIMS ensures same authorization checks are employed for these clients as the CLI and GUI clients.

The token generation interface can be invoked by any Admin to generate a new token that is valid for the period as defined by the system (default 60 days) from a given client machine (IP/Host). The generated token can be used from the same system and the Admin's credentials are applied to the API calls invoked with that token.

Example invocation of token generation interface using curl –

curl –H "Content-Type: application/json" -d '{"ip':'', "application':'', "description':'', "login_id':'', "password':''}' 'https://:/tims/rest/auth_token/generate'

3. Enabling Rest Access

To generate an authentication token in the TCPWave IPAM, login to the TCPWave IPAM GUI and go to Security Administration page by clicking on the Security Administration menu item in the Configuration menu located at the top section the IPAM Interface. The Security Administration page is divided into two panes. The left pane consists of the links to the Security Administration Tools. The Right pane displays the current view selected in the left pane. Click on the Session Tokens link to display the Session Tokens view in the right pane.

The Session Tokens the list of Session Tokens in the TCPWave IPAM in a tabular format. The table also includes Session Token details like session token name, IP address, application, active, admin, generated from IP address, generated date and description.

To generate a new session token:

  1. Click on the Generate button located on the top left corner of the session tokens grid.
  2. Generate Session Token dialog will appear
  3. Enter the Application name
  4. Enter the IP address
  5. Optionally enter the description
  6. Click on OK

4. Resources

4.1. AML Service

Description

This service provides API's to add Address Match List(AML) , update Address Match List(AML), get the details of an Address Match List(AML) in the TCPWave IPAM.

4.1.1. AML Create

POST /amls/create
Description

Creates an Address Match List in the TCPWave IPAM. An AML is a list of IP Addresses used to define the Access Control Lists (ACLs) such as Allow-Update, Allow-Query, Allow-Transfer, Allow-Notify etc. The ACLs control the behavior of TCPWave DNS software.

Parameters
Type Name Schema

Body

body
optional

Access Control List(ACL)

Responses
HTTP Code Description Schema

200

successful operation

integer(int32)

Consumes
  • application/json

  • application/xml

Produces
  • application/json

4.1.2. AML Details

GET /amls/details/{amlId}
Description

Obtains a list of the Address Match List (AML) defined and managed by the TCPWave IPAM. An AML is a list of IP Addresses used to define the Access Control Lists (ACLs) such as Allow-Update, Allow-Query, Allow-Transfer, Allow-Notify etc. The ACLs control the behavior of TCPWave DNS software.

Example Http Request
GET https://example.com:7443/tims/rest/amls/details/30266
Example Http Response
Content-Type : application/json
Content-Length : 412"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/amls/details/30266"
Parameters
Type Name Description Schema

Path

amlId
required

AML Id

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

Access Control List(ACL)

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.1.3. AML Edit

POST /amls/update
Description

Updates the list of the Address Match List (AML) in the TCPWave IPAM. An AML is a list of IP Addresses used to define the Access Control Lists (ACLs) such as Allow-Update, Allow-Query, Allow-Transfer, Allow-Notify etc. The ACLs control the behavior of TCPWave DNS software.

Parameters
Type Name Schema

Body

body
optional

Access Control List(ACL)

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • text/plain

4.2. Acl Service

Description

This service provides API's to get list of Access Control List(ACL) present in the TCPWave IPAM, add Access Control List(ACL) , update Access Control List(ACL), delete Access Control List(ACL), search for an Access Control List(ACL) in the TCPWave IPAM.

4.2.1. ACL Create

POST /acls/create
Description

Creates a new Access Control List (ACL) in the TCPWave IPAM. This list is used to control the behavior of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc.

Example Http Request
https://example.com:7443/tims/rest/acls/create  -POST  {"id":0,"name":"internal","description":"internal servers","special":0,"sequence":0,"exclude":0,"aclDataList":[],"aclElementList":[{"id":0,"special":0,"value":"173.0.2.0/24","sequence":1,"exclude":0,"aclDataList":[],"aclElementList":[],"referenceCount":0},{"id":0,"special":0,"value":"173.0.0.3","sequence":2,"exclude":1,"aclDataList":[],"aclElementList":[],"referenceCount":0}],"referenceCount":0}
Example Http Response
Content-Type : application/json
Content-Length : null
Status code :200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/acls/create  -d  '{"id":0,"name":"internal","description":"internal servers","special":0,"sequence":0,"exclude":0,"aclDataList":[],"aclElementList":[{"id":0,"special":0,"value":"173.0.2.0/24","sequence":1,"exclude":0,"aclDataList":[],"aclElementList":[],"referenceCount":0},{"id":0,"special":0,"value":"173.0.0.3","sequence":2,"exclude":1,"aclDataList":[],"aclElementList":[],"referenceCount":0}],"referenceCount":0}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Access Control List(ACL)

Responses
HTTP Code Description Schema

500

TIMS-2002: ACL already exists, TIMS-2007: ACL name is not valid.

No Content

Consumes
  • application/json

  • application/xml

4.2.2. CSV for Search

POST /acls/csvforsearch
Description

Generates a CSV file for the search results of the Access Control List(ACL) in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.2.3. ACL Delete

POST /acls/delete/{aclName}
Description

Deletes an existing Access Control List(ACL) from the TCPWave IPAM’s data repository. This action is audited.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Path

aclName
required

ACL Name

string

Responses
HTTP Code Description Schema

500

TIMS-2001: ACL(s) not found, TIMS-2004: ACL is referenced in the server templates. Please delete those references and retry.

No Content

Consumes
  • application/json

  • application/xml

4.2.4. ACL Details

GET /acls/get
Description

Provides the list of Access Control List(ACL) In the TCPWave IPAM which are used to control the behaviour of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc.

Example Http Request
https://example.com:7443/tims/rest/acls/get?name=cardsprod  
Example Http Response
Content-Type : application/json
Content-Length : 7657
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/acls/get?name=cardsprod  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

name
required

ACL Name

string

Responses
HTTP Code Description Schema

200

successful operation

Access Control List(ACL)

500

TIMS-2001: ACL(s) not found

No Content

Produces
  • application/json

  • application/xml

4.2.5. ACL List

GET /acls/list
Description

Obtains the list of Access Control List(ACL) defined and managed by the TCPWave IPAM which are used to control the behaviour of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc.

Example Http Request
https://example.com:7443/tims/rest/acls/list  
Example Http Response
Content-Type : application/json
Content-Length : 3234
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/acls/list  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< Access Control List(ACL) > array

500

TIMS-2001: ACL(s) not found

No Content

Produces
  • application/json

  • application/xml

4.2.6. ACL Delete Multiple

POST /acls/multidelete
Description

Deletes multiple existing Access Control List(ACL) from the TCPWave IPAM’s data repository. This action is audited.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

< string > array

Responses
HTTP Code Description Schema

500

TIMS-2001: ACL(s) not found, TIMS-1307: Root zone(s) does(do) not exist.

No Content

Consumes
  • application/json

  • application/xml

4.2.7. Find ACL References

GET /acls/references
Description

Obtains a list of Access Control List(ACL) references present in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/acls/search?id=4323&page=1&rows=20
Example Http Response
Content-Type : application/json
Content-Length : 21"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/acls/search?id=4323&page=1&rows=20
Parameters
Type Name Description Schema

Query

count
optional

ACL Count

string

Query

id
required

ACL Id

string

Query

page
required

Page Number

integer(int32)

Query

rows
optional

Number of Rows

integer(int32)

Query

tables
optional

Input Table

string

Responses
HTTP Code Description Schema

200

successful operation

Reference Results

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.2.8. Search ACL

GET /acls/search
Description

Provides the list of searched Access Control List(ACL) on search screen in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/acls/search?page=1&rows=20
Example Http Response
Content-Type : application/json
Content-Length : 21"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/acls/search?page=1&rows=20"
Parameters
Type Name Description Schema

Query

page
optional

Page Number

integer(int32)

Query

rows
optional

Number of Rows

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAccess Control List(ACL)

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.2.9. ACL Edit

POST /acls/update
Description

Edits an existing Access Control List(ACL) in the TCPWave IPAM .

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Access Control List(ACL)

Responses
HTTP Code Description Schema

500

TIMS-2001: ACL(s) not found, TIMS-2002: ACL already exists, TIMS-2006: ACL is not valid.

No Content

Consumes
  • application/json

  • application/xml

4.3. Active Directory Service

Description

This service class provides REST API access to Create and Delete a mapping of existing Active Directory Domain Services (AD DS) User Principal Name (UPN) into TCPWave IPAM.

4.3.1. Authenticate Active Directory User

POST /activedirectory/authenticate
Description

Validates authentication between 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.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Active Directory

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-1207: Please select an Active Directory user principal name (UPN) for authentication,

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.3.2. Active Directory User Delete

POST /activedirectory/delete
Description

Removes mapping of existing Active Directory Domain Services (AD DS) User Principal Name (UPN) from TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

< Active Directory > array

Responses
HTTP Code Description Schema

500

TIMS-7003: You are not authorized to perform this operation, TIMS-1203: Please select an Active Directory user principal (UPN) name to delete.

No Content

Consumes
  • application/json

  • application/xml

4.3.3. Active Directory User Add

POST /activedirectory/useradd
Description

Creates a mapping of existing Active Directory Domain Services (AD DS) User Principal Name (UPN) into TCPWave IPAM. A UPN is the name of a system user in an e-mail address format. The user name (or 'username') is followed by the 'at sign' followed by the name of the domain with which the user is associated.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Active Directory

Responses
HTTP Code Description Schema

500

TIMS-7003: You are not authorized to perform this operation, TIMS-1312: Duplicate entry.

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

4.3.4. Active Directory User list

GET /activedirectory/userlist
Description

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. The user name (or 'username') is followed by the 'at sign' followed by the name of the Internet domain with which the user is associated.

Example Http Request
GET https://example.com:7443/tims/rest/activedirectory/userlist
Example Http Response
Content-Type : application/json
Content-Length : 1129"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/activedirectory/userlist
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Active Directory

Responses
HTTP Code Description Schema

200

successful operation

< Active Directory > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.4. Admin Group Service

Description

This service provides API access to perform admin group operations. Operations include add an admin group, update an admin group , list admin group, delete an admin group, retrieve admin group permissions and update admin group permissions.

4.4.1. Admin Group Add

POST /admingroup/add
Description

Creates a new admin group. Functional Admin can create an Admin Group in any organization. Super Admin and User Admin can create Admin Groups only in the organization that they belong to.

Example Http Request
https://example.com:7443/tims/rest/admingroup/add  -POST  {"name":"org-admin-group","description":"Test Admin Group","organization_name":"Internal"}
Example Http Response
Content-Type : application/json
Content-Length : 231
Status code :200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/admingroup/add  -d  '{"name":"org-admin-group","description":"Test Admin Group","organization_name":"Internal"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Admin Group

Responses
HTTP Code Description Schema

500

TIMS-1101: Cannot find organization, TIMS-1100: Both organization name and id cannot be null, TIMS-1401: Admin group already defined

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.4.2. Admin Group Delete

POST /admingroup/delete
Description

Deletes an existing Admin group. Functional Admin can delete an Admin Group belonging to any organization. Super Admin and User Admin can update Admin Groups only in the organization that they belong to.

Example Http Request
https://example.com:7443/tims/rest/admingroup/delete?name=default-admin-group&organization_name=Internal  -POST
Example Http Response
Content-Type : application/json
Content-Length : 58
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/admingroup/delete?name=default-admin-group&organization_name=Internal  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

id
required

Admin Group ID

integer(int32)

Query

name
required

Admin Group Name

string

Query

organization_id
required

Organization ID associated with Admin Group

string

Query

organization_name
required

Organization Name associated with Admin Group

string

Responses
HTTP Code Description Schema

500

TIMS-1140: Both admin groups id and name cannot be null, TIMS-1141: Cannot find admin group, TIMS-1142: Admin group does not exist, TIMS-1143: Admin group can not be deleted as it is associated with existing users.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.4.3. Admin Group List

GET /admingroup/list
Description

Obtains a List of all Admin Groups defined and managed by the TCPWave IPAM. Functional Admin gets the list of all admin groups. Rest of the Admins get only the list of admin groups associated with the organization that they belong to.

Example Http Request
https://example.com:7443/tims/rest/admingroup/list  
Example Http Response
Content-Type : application/json
Content-Length : 278
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/admingroup/list  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

org_id
required

Organization ID

integer(int32)

Query

org_name
required

Organization Name

string

Responses
HTTP Code Description Schema

200

successful operation

< Admin Group > array

500

TIMS-1101: Cannot find organization.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.4.4. Admin Group Permission List

GET /admingroup/permlist
Description

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 of the admins are restricted to the admin groups that belong to their organization.

Example Http Request
GET https://example.com:7443/tims/rest/admingroup/permlist?group_id=819
Example Http Response
Content-Type : application/json
Content-Length : 2"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/admingroup/permlist?group_id=819
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

group_id
required

Admin Group ID

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

< User Permission > array

500

TIMS-1101: Cannot find organization.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.4.5. Find Admin Group References

GET /admingroup/references
Description

Retrieve the admin group references in TCPWave IPAM.

Parameters
Type Name Description Schema

Query

count
required

total records

string

Query

id
required

Admin Group ID

string

Query

page
required

total result pages

integer(int32)

Query

rows
required

rows per page

integer(int32)

Query

tables
required

reference tables

string

Responses
HTTP Code Description Schema

200

successful operation

Reference Results

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.4.6. Remove Permission for Admin Group

POST /admingroup/remove/permission
Description

Delete the current permission on an admin group in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

group_id
required

Admin Group ID

integer(int32)

Body

body
optional

< integer(int32) > array

Responses
HTTP Code Description Schema

500

TIMS-7003: You are not authorized to perform this operation.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.4.7. Remove Admin from Admin Group

POST /admingroup/remove/user
Description

Delete the current user from an admin group in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

group_id
required

Admin Group ID

integer(int32)

Body

body
optional

< integer(int32) > array

Responses
HTTP Code Description Schema

500

TIMS-7003: You are not authorized to perform this operation.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.4.8. Search Admin Group

GET /admingroup/search
Description

Search all admin gruoups associated with an organization in TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/admingroup/search?page=1&rows=20
Example Http Response
Content-Type : application/json
Content-Length : 21"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/admingroup/search?page=1&rows=20"
Parameters
Type Name Description Schema

Query

page
required

total result pages

integer(int32)

Query

rows
required

rows per page

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAdmin Group

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.4.9. Admin Group Modify

POST /admingroup/update
Description

Edits an existing Admin group. Functional Admin can update an Admin Group belonging to any organization. Super Admin and User Admin can update Admin Groups only in the organization that they belong to.

Example Http Request
https://example.com:7443/tims/rest/admingroup/update  -POST  {"name":"default-group","oldName":"default-admin-group","description":"Default Admin Group","organization_name":"TCPWave"}
Example Http Response
Content-Type : application/json
Content-Length : 60
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/admingroup/update  -d  '{"name":"default-group","oldName":"default-admin-group","description":"Default Admin Group","organization_name":"TCPWave"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Admin Group

Responses
HTTP Code Description Schema

500

TIMS-1101: Cannot find organization, TIMS-1100: Both organization name and id cannot be null, TIMS-1402: Admin group does not exist

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.5. Algorithm Service

Description

This service provides API's to get list of Algorithm present in the TCPWave IPAM and list of Transaction SIGnature(TSIG)Algorithm in the TCPWave IPAM.

4.5.1. Algorithm List

GET /algo/list
Description

Obtains a list of valid DNS signing algorithms in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/algo/list
Example Http Response
Content-Type : application/json
Content-Length : 1464"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/algo/list"
Responses
HTTP Code Description Schema

200

successful operation

< Algorithm > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.5.2. Algorithm TSIG List

GET /algo/tsiglist
Description

Obtains a list of Transaction Signature(TSIG) key algorithms supported by the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/algo/tsiglist
Example Http Response
Content-Type : application/json
Content-Length : 480"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/algo/tsiglist
Responses
HTTP Code Description Schema

200

successful operation

< Algorithm > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.6. Asset Service

Description

This service provides the API to manage Assets in TCPWave IPAM.

4.6.1. Add Asset

POST /asset/add
Description

Creates a new asset in the TCPWave IPAM. An asset can be associated to an object so that an IP Address can be associated to a service tag number for proper inventory reconciliation.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Asset

Responses
HTTP Code Description Schema

500

TIMS-7777: Specified asset already exists.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.6.2. Delete Asset

POST /asset/delete
Description

Deletes an existing asset defined in the TCPWave IPAM. An asset can be associated to an object so that an IP Address can be associated to a service tag number for proper inventory reconciliation.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

service_tag
required

Asset Service Tag

string

Responses
HTTP Code Description Schema

500

TIMS-1703: Please select an asset to delete.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.6.3. Delete Assets

POST /asset/deleteAll
Description

Deletes all available assets defined in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

< string > array

Responses
HTTP Code Description Schema

500

TIMS-1703: Please select an asset to delete.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.6.4. Update Asset

POST /asset/edit
Description

Edits an existing asset defined in the TCPWave IPAM. An asset can be associated to an object so that an IP Address can be associated to a service tag number for proper inventory reconciliation.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

service_tag
optional

Asset Service Tag

string

Body

body
optional

Asset

Responses
HTTP Code Description Schema

500

TIMS-1701: Please select a single asset to edit. TIMS-1702: Please select an asset to edit.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.6.5. Get Asset Details

GET /asset/get
Description

Provides the details of a given asset defined in the TCPWave IPAM. An asset can be associated to an object so that an IP Address can be associated to a service tag number for proper inventory reconciliation.

Parameters
Type Name Description Schema

Query

service_tag
required

Asset Service Tag

string

Responses
HTTP Code Description Schema

200

successful operation

Asset

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

4.6.6. Asset List

GET /asset/list
Description

Obtains a list of assets defined and managed by the TCPWave IPAM. An asset can be associated to an object so that an IP Address can be associated to a service tag number for proper inventory reconciliation.

Example Http Request
GET https://example.com:7443/tims/rest/asset/list
Example Http Response
Content-Type : application/json
Content-Length : 973"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/asset/list"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< Asset > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.7. Audit Logs And License Information

Description

This service provides the API to access the audit logs in TCPWave IPAM and purge the audit records. This service also provides the API to access the IPAM license information and update the license key.

4.7.1. License Details

GET /audit/license
Description

Obtains the License information from the TCPWave IPAM. A new license keys can be procured by contacting the TCPWave Customer Care team or a distributor or a reseller in your region.

Example Http Request
https://example.com:7443/tims/rest/audit/license  
Example Http Response
Content-Type : application/json
Content-Length : 176
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/audit/license  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

License Data

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.7.2. Update License

POST /audit/license/update
Description

Updates the TCPWave IPAM product licence on the management appliance. Only Functional Admin can update the license information. A new license keys can be procured by contacting the TCPWave Customer Care team or a distributor or a reseller in your region.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

string

Responses
HTTP Code Description Schema

200

successful operation

License Data

500

TIMS-3901: Invalid License Key specified.

No Content

Consumes
  • application/json

Produces
  • application/json

  • application/xml

4.7.3. Audit Log List

GET /audit/page
Description

Obtains a list of audit logs from the TCPWave IPAM.

Parameters
Type Name Description Schema

Query

description
required

Description of each record

string

Query

end_date
required

End Date for fetching Records

string

Query

login_name
required

Name of Admin

string

Query

page
required

Page number

integer(int32)

Query

remote_ip
required

IP Address

string

Query

rows
required

Rows per page

integer(int32)

Query

session_id
required

Session ID

string

Query

start_date
required

Start Date for fetching Records

string

Query

success
required

If operation is successful?(YES/NO)

boolean

Query

target
required

Entity type(Network/Subnet/Object/Database)

string

Query

target_instance
required

Entity(Network-192.168.1.10)

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Entry

500

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.7.4. Purge Audit History

POST /audit/purgeaudithistory
Description

Purges the Audit history from the TCPWave IPAM. This action is typically performed to conserve disk space or to reduce the size of the database. Audit history is also typically purged while performing a major upgrade from the web interface or the CLI.

Example Http Request
https://example.com:7443/tims/rest/audit/purgeaudithistory?numOfDays=2  -POST
Example Http Response
Content-Type : application/json
Content-Length : 0
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/audit/purgeaudithistory?numOfDays=2  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

numOfDays
required

integer(int32)

Responses
HTTP Code Schema

500

No Content

Consumes
  • application/json

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.8. Audit Report Service

Description

This class contains information related to all reports. The class includes grid functionality, download reports in CSV format, PDF format, send reports via email to the selected contacts in PDF format , schedules email in a specific time and provides list of all dropdowns for all audit reports.

4.8.1. Action List

GET /auditreports/actionslist
Description

User can select active or deleted option. Active option obtains a list of active administrators defined in the TCPWave IPAM and deleted option obtains a list of deleted administrators defined in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/auditreports/actionslist
Example Http Response
Content-Type : application/json
Content-Length : 2363"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/auditreports/actionslist"
Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.8.2. Admin Role List

GET /auditreports/adminroleslist
Description

Obtains a list of administrators types (eg. FADM, SADM etc.)defined in the TCPWave IPAM. Please refer to the product documentation for additional information about the various administrator types.

Example Http Request
GET https://example.com:7443/tims/rest/auditreports/adminroleslist
Example Http Response
Content-Type : application/json
Content-Length : 151"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/auditreports/adminroleslist"
Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.8.3. Admin List

GET /auditreports/adminslist
Description

Obtains a list of administrators defined in the TCPWave IPAM. Please refer to the product documentation for additional information about the various administrator types.

Example Http Request
GET https://example.com:7443/tims/rest/auditreports/adminslist?actionType=active
Example Http Response
Content-Type : application/json
Content-Length : 512"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/auditreports/adminslist?actionType=active"
Parameters
Type Name Description Schema

Query

actionType
required

Action Type

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.8.4. Network List

GET /auditreports/auditnetworkslist
Description

Obtains a list of existing networks and deleted networks for auditing purposes.

Example Http Request
https://example.com:7443/tims/rest/auditreports/auditnetworkslist?actionType=active&page=1&rows=121  
Example Http Response
Content-Type : application/json
Content-Length : 7609
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/auditreports/auditnetworkslist?actionType=active&page=1&rows=121  
Parameters
Type Name Description Schema

Query

actionType
required

type of action - add/modify/delete

string

Query

page
required

page number

integer(int32)

Query

q
required

search string

string

Query

rows
required

rows per page

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.8.5. Zone List

GET /auditreports/auditzoneslist
Description

Obtains a list of existing DNS Zones and deleted DNS Zones for auditing purposes.

Example Http Request
https://example.com:7443/tims/rest/auditreports/auditzoneslist?actionType=active&page=1&rows=152  
Example Http Response
Content-Type : application/json
Content-Length : null
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/auditreports/auditzoneslist?actionType=active&page=1&rows=152  
Parameters
Type Name Description Schema

Query

actionType
required

type of action - active/deleted

string

Query

page
required

page number

integer(int32)

Query

q
required

search string

string

Query

rows
required

rows per page

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.8.6. CSV Report

POST /auditreports/csvreport
Description

Provides a csv file for audit reports present in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/auditreports/csvreport  -POST  {"reportType":"ipv4Network","ipAddress_domainName":"16","fromDate":"2016/12/28","toDate":"2016/12/28","rows":142}
Example Http Response
Content-Type : application/json
Content-Length : 83
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/auditreports/csvreport  -d  '{"reportType":"ipv4Network","ipAddress_domainName":"16","fromDate":"2016/12/28","toDate":"2016/12/28","rows":142}'
Parameters
Type Name Description Schema

Query

action
required

Operation executed by Admin

string

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-9314: Export to CSV failed.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.8.7. Email Report

POST /auditreports/emailreport
Description

User can send the generated audit report to the email address of the contacts present in the TCPWave IPAM.

Parameters
Type Name Description Schema

Query

action
required

Operation executed by Admin(active/deleted)

string

Query

adminName
required

Name of Network Admin

string

Query

adminRole
required

Role of Admin (FADM/SADM/UADM/RADM)

string

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-9312: Current selection exceeds the allowable Email size. Please modify your criteria or use CSV file download.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.8.8. IPv4 Network List

GET /auditreports/ipv4Network
Description

Obtains a list of existing IPv4 networks and deleted IPv4 networks for auditing purposes.

Example Http Request
https://example.com:7443/tims/rest/auditreports/ipv4Network  
Example Http Response
Content-Type : application/json
Content-Length : 126
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/auditreports/ipv4Network  
Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.8.9. IPv4 Subnet List

GET /auditreports/ipv4Subnet
Description

Obtains a list of existing IPv4 Subnets and deleted IPv4 Subnets for auditing purposes.

Example Http Request
https://example.com:7443/tims/rest/auditreports/ipv4Subnet  
Example Http Response
Content-Type : application/json
Content-Length : 527
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/auditreports/ipv4Subnet  
Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.8.10. PDF Report

POST /auditreports/pdfreport
Description

Provides a PDF format report for the audit report in the TCPWave IPAM.

Parameters
Type Name Description Schema

Query

action
required

Operation executed by Admin

string

Query

adminName
required

Name of Network Admin

string

Query

adminRole
required

Role of Admin (FADM/SADM/UADM/RADM)

string

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-9313: Current selection exceeds the allowable PDF size. Please modify your criteria or use CSV file download.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.8.11. Admin Audit

GET /auditreports/reportlist
Description

Obtains a list of reports in grid for the audit reports in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/auditreports/reportlist?ipAddress_domainName=tcpwave.com&fromDate=2015/05/01&toDate=2015/08/01&reportType=Zone&page=1&rows=20  
Example Http Response
Content-Type : application/json
Content-Length : 21
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/auditreports/reportlist?ipAddress_domainName=tcpwave.com&fromDate=2015/05/01&toDate=2015/08/01&reportType=Zone&page=1&rows=20  
Parameters
Type Name Description Schema

Query

action
required

Action performed

string

Query

filterRules
required

Filter rule

string

Query

fromDate
required

From Date

string

Query

ipAddress_domainName
required

Domain name

string

Query

order
required

order param(asc/desc)

string

Query

page
required

Page Number

integer(int32)

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

sort
required

Sorting rule

string

Query

toDate
required

Up to Date

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

500

TIMS-8059: Please select report start date. TIMS-8060: Please select report end date.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.8.12. Schedule Report Email

POST /auditreports/sched_emailreport
Description

User can Schedule the time to email the report in PDF format to the email address of the contacts present in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

action
required

active/deleted

string

Query

adminName
required

Name of Network Admin who is scheduling the email

string

Query

adminRole
required

Role of Admin (FADM/SADM/UADM/RADM)

string

Query

day
required

Day of Execution of scheduled operation

integer(int32)

Query

description
required

Desription about scheduled operation

string

Query

endtime
required

Ending time for execution of scheduled operation

string

Query

frequency
required

Frequency of scheduled operation

string

Query

repeat
required

Occurences of scheduled operation

integer(int32)

Query

repeatCount
required

Count for repetition of scheduled operation

integer(int32)

Query

repeatInterval
required

Time duration between repetition of scheduled operation

integer(int64)

Query

runtime
required

Execution time of scheduled operation

string

Query

starttime
required

Starting time for execution of scheduled operation

string

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.9. Audit Report Details

Description

This class contains information related to all reports. The class includes grid functionality, download reports in CSV format, PDF format, send reports via email to the selected contacts in PDF format , schedules email in a specific time and provides list of all dropdowns for all audit reports.

4.9.1. DHCP Active Server List

GET /reports/DhcpLeaseServerlist
Description

Provides a list of existing DHCP servers and deleted DHCP servers for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/DhcpLeaseServerlist
Example Http Response
Content-Type : application/json
Content-Length : 436"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/DhcpLeaseServerlist"
Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.2. DHCP Server Subnet List

GET /reports/DhcpServerSubnetlist
Description

Provides a list of existing DHCP servers and deleted DHCP servers for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/DhcpServerSubnetlist?actionType=active
Example Http Response
Content-Type : application/json
Content-Length : 366"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/DhcpServerSubnetlist?actionType=active"
Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.3. DHCP Server List

GET /reports/DhcpServerlist
Description

Provides a list of existing DHCP servers and deleted DHCP servers for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/DhcpServerlist?actionType=active
Example Http Response
Content-Type : application/json
Content-Length : 366"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/DhcpServerlist?actionType=active"
Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.4. Parameter List

GET /reports/allparams
Description

Provides a list of all parameters in DHCP option template report for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/allparams?server_type_code=DHCP&entity_type_code=OPTION&page=1&rows=20
Example Http Response
Content-Type : application/json
Content-Length : 1698"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/allparams?server_type_code=DHCP&entity_type_code=OPTION&page=1&rows=20"
Parameters
Type Name Description Schema

Query

entity_type_code
required

Entity type

string

Query

page
required

Total pages

integer(int32)

Query

q
required

Search string

string

Query

rows
required

Rows per page

integer(int32)

Query

server_type_code
required

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.5. DNS Views List

GET /reports/auditviewslist
Description

Provides a list of existing and deleted DNS Views for auditing purposes.

Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Query

org_id
required

Organization ID

integer(int32)

Query

page
required

Total pages

integer(int32)

Query

q
required

Search string

string

Query

rows
required

Rows per page

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.6. CSV Report

POST /reports/csvreport
Description

Provides a csv file for audit reports present in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/reports/csvreport  -POST  {"reportType":"rawDataReport","rows":0}
Example Http Response
Content-Type : application/json
Content-Length : 71
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/reports/csvreport  -d  '{"reportType":"rawDataReport","rows":0}'
Parameters
Type Name Schema

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-9314: Export to CSV failed.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.9.7. Device Utilization report CSV

GET /reports/deviceUtilCsvReport
Description

Provides a csv file for Device Utilization report present in the TCPWave IPAM.

Parameters
Type Name Description Schema

Query

fromDate
required

Starting date for fetching records

string

Query

input_cpu
required

Used CPU percentage

integer(int32)

Query

input_disk
required

Used Disk percentage

integer(int32)

Query

input_mem
required

Used Memory percentage

integer(int32)

Query

page
required

Total pages

integer(int32)

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

serverIp
required

IP of the Server

string

Query

serverName
required

Name of the selected Server

string

Query

toDate
required

Ending date for fetching records

string

Responses
HTTP Code Description Schema

200

successful operation

string

500

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.8. Device Utilization Server List

GET /reports/deviceUtilReportServerlist
Description

Provides a list of existing servers and deleted servers for auditing purposes.

Parameters
Type Name Description Schema

Query

fromDate
required

Starting date for fetching records

string

Query

input_cpu
required

Used CPU percentage

integer(int32)

Query

input_disk
required

Used Disk percentage

integer(int32)

Query

input_mem
required

Used Memory percentage

integer(int32)

Query

page
required

Total pages

integer(int32)

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

serverIp
required

IP of the Server

string

Query

serverName
required

Name of the selected Server

string

Query

toDate
required

Ending date for fetching records

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListServer Load

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.9. DNS Servers and DHCP Servers List

GET /reports/deviceUtilReportlist
Description

Provides a list of existing DNS servers and DHCP servers for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/deviceUtilReportlist
Example Http Response
Content-Type : application/json
Content-Length : 395"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/deviceUtilReportlist"
Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.10. DHCP active leases audit report

GET /reports/dhcpActiveLeases
Description

Provides report details in grid for DHCP active leases audit report in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dhcpActiveLeases?serverIp=10.189.0.13&page=1&rows=20&fromDate=2017/01/01&toDate=2017/01/03&reportType=DhcpLeaseAudit
Example Http Response
Content-Type : application/json
Content-Length : 21"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dhcpActiveLeases?serverIp=10.189.0.13&page=1&rows=20&fromDate=2017/01/01&toDate=2017/01/03&reportType=DhcpLeaseAudit"
Parameters
Type Name Description Schema

Query

fromDate
required

Starting date for fetching records

string

Query

page
required

Total pages

integer(int32)

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

serverIp
required

IP of the Server

string

Query

toDate
required

Ending date for fetching records

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListDHCP Lease Data

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.11. DHCP active leases Audit Report

GET /reports/dhcpLeaseCsvReport
Description

Provides a csv file for DHCP active leases audit report present in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dhcpLeaseCsvReport?serverIp=10.189.0.13&page=1&rows=20&reportType=subnet
Example Http Response
Content-Type : application/json
Content-Length : 64"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dhcpLeaseCsvReport?serverIp=10.189.0.13&page=1&rows=20&reportType=subnet"
Parameters
Type Name Description Schema

Query

page
required

Total pages

integer(int32)

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

serverIp
required

IP of the Server

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.12. DHCP Option Template Report

GET /reports/dhcpoptionconfigreportlist
Description

Provides report details in grid for DHCP Option Template Report in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dhcpoptionconfigreportlist?config_name=subnet-mask¶m_val=24&reportType=DhcpOptionTemplConfigRpt
Example Http Response
Content-Type : application/json
Content-Length : 21"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dhcpoptionconfigreportlist?config_name=subnet-mask¶m_val=24&reportType=DhcpOptionTemplConfigRpt"
Parameters
Type Name Description Schema

Query

config_name
required

string

Query

filterRules
required

filter rules

string

Query

page
required

page number

integer(int32)

Query

param_val
required

parameter value

string

Query

q
required

search string

string

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

rows per page

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.13. DHCP Option Template List

GET /reports/dhcpoptiontemplassolist
Description

Provides a list of existing DHCP option template and deleted DHCP option template for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dhcpoptiontemplassolist
Example Http Response
Content-Type : application/json
Content-Length : 593"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dhcpoptiontemplassolist"
Parameters
Type Name Description Schema

Query

page
required

Total pages

integer(int32)

Query

q
required

Search string

string

Query

rows
required

Rows per page

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.14. DHCP Option Template List

GET /reports/dhcpoptiontemplauditlist
Description

Provides a list of existing DHCP option template and deleted DHCP option template for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dhcpoptiontemplauditlist?actionType=active&page=1&rows=20
Example Http Response
Content-Type : application/json
Content-Length : 511"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dhcpoptiontemplauditlist?actionType=active&page=1&rows=20"
Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Query

page
required

Total pages

integer(int32)

Query

q
required

Search string

string

Query

rows
required

Rows per page

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.15. DHCP Policy Template List

GET /reports/dhcppolicytemplauditlist
Description

Provides a list of existing DHCP policy template and deleted DHCP policy template for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dhcppolicytemplauditlist?actionType=active&page=1&rows=20
Example Http Response
Content-Type : application/json
Content-Length : 2"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dhcppolicytemplauditlist?actionType=active&page=1&rows=20"
Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.16. DHCP Server Association audit report

GET /reports/dhcpserversubnetreportlist
Description

Provides report details in grid for DHCP Server Association audit report in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dhcpserversubnetreportlist?reportType=DhcpServerSubnetRpt&ipAddress_domainName=10.1.10.184&page=1&rows=20
Example Http Response
Content-Type : application/json
Content-Length : 3408"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dhcpserversubnetreportlist?reportType=DhcpServerSubnetRpt&ipAddress_domainName=10.1.10.184&page=1&rows=20"
Parameters
Type Name Description Schema

Query

filterRules
required

Filter rules

string

Query

ipAddress_domainName
required

IP Address of this domain

string

Query

page
required

Page number

integer(int32)

Query

q
required

Search string

string

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.17. DHCP Option Template Association Report

GET /reports/dhcptemplassoreportgrid
Description

Provides report details in grid for DHCP Option Template Association Report in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dhcptemplassoreportgrid?reportType=dhcpTemplAssoScope&optionTempl=Manual%20DHCP%20Option%20Template-1&asso_type=scope&page=1&rows=20
Example Http Response
Content-Type : DataEncoding
Content-Length : 0"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dhcptemplassoreportgrid?reportType=dhcpTemplAssoScope&optionTempl=Manual%20DHCP%20Option%20Template-1&asso_type=scope&page=1&rows=20"
Parameters
Type Name Description Schema

Query

asso_type
required

Type of association of Option Template with DHCP Server

string

Query

filterRules
required

filter rule string

string

Query

optionTempl
required

Name of Option Template

string

Query

page
required

Page number

integer(int32)

Query

q
required

Search string

string

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.18. Network List

GET /reports/dnsauthserverslist
Description

Provides a list of existing networks and deleted networks for auditing purposes.

Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.19. DNS and DHCP Server List

GET /reports/dnsdhcpserverslist
Description

Provides a list of existing DNS servers and DHCP servers for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dnsdhcpserverslist
Example Http Response
Content-Type : application/json
Content-Length : 1534"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dnsdhcpserverslist"
Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.20. DNS option template List

GET /reports/dnsoptiontemplauditlist
Description

Provides a list of existing DNS option template and deleted DNS option template for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dnsoptiontemplauditlist?actionType=active
Example Http Response
Content-Type : application/json
Content-Length : 340"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dnsoptiontemplauditlist?actionType=active"
Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.21. Network List

GET /reports/dnsserverslist
Description

Provides a list of existing networks and deleted networks for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dnsserverslist?actionType=active
Example Http Response
Content-Type : application/json
Content-Length : 1434"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dnsserverslist?actionType=active"
Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.22. DNS SOA Report CSV

GET /reports/dnssoareportcsv
Description

Provides a csv file for DNS SOA report present in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dnssoareportcsv?reportType=dnsSOAreport&serverIp=169.181.11.243&serverName=nhkna81-qrs01-sl0984&server_type=BIND%20AUTH
Example Http Response
Content-Type : application/json
Content-Length : 61"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dnssoareportcsv?reportType=dnsSOAreport&serverIp=169.181.11.243&serverName=nhkna81-qrs01-sl0984&server_type=BIND%20AUTH"
Parameters
Type Name Description Schema

Query

page
required

Total pages

integer(int32)

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

serverIp
required

IP of the Server

string

Query

serverName
required

Name of the selected Server

string

Query

server_type
required

Type of the Server (DNS/DHCP)

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.23. DNS SOA Report Grids

GET /reports/dnssoareportgrid
Description

Provides report details in grid for DNS SOA report in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dnssoareportgrid?fromDate=Invalid&toDate=Invalid&reportType=dnsSOAreport&serverIp=169.181.11.243&serverName=nhkna81-qrs01-sl0984&server_type=BIND%20AUTH&page=1&rows=20
Example Http Response
Content-Type : application/json
Content-Length : 21"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dnssoareportgrid?fromDate=Invalid&toDate=Invalid&reportType=dnsSOAreport&serverIp=169.181.11.243&serverName=nhkna81-qrs01-sl0984&server_type=BIND%20AUTH&page=1&rows=20"
Parameters
Type Name Description Schema

Query

page
required

Total pages

integer(int32)

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

serverIp
required

IP of the Server

string

Query

serverName
required

Name of the selected Server

string

Query

server_type
required

Type of the Server (DNS/DHCP)

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListSOA

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.24. DNS Template List

GET /reports/dnstemplatelist
Description

Provides a list of existing DNS templates and deleted DNS templates for auditing purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/dnstemplatelist?actionType=active
Example Http Response
Content-Type : application/jsonn
Content-Length : 62"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/dnstemplatelist?actionType=active"
Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.25. Email Report

POST /reports/emailreport
Description

User can send the generated audit report to the email address of the contacts present in the TCPWave IPAM.

Parameters
Type Name Schema

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-9312: Current selection exceeds the allowable Email size. Please modify your criteria or use CSV file download.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.9.26. Last 100 Event List

GET /reports/last100eventslist
Description

Provides a list of last 100 events performed in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/reports/last100eventslist?fromDate=1/2/2017&toDate=1/2/2017&reportType=Last100Events&ipAddress_domainName=undefined&page=1&rows=20
Example Http Response
Content-Type : application/json
Transfer-Encoding : chunked"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/last100eventslist?fromDate=1/2/2017&toDate=1/2/2017&reportType=Last100Events&ipAddress_domainName=undefined&page=1&rows=20"
Parameters
Type Name Description Schema

Query

filterRules
required

Filter rule string

string

Query

fromDate
required

Starting date for fetching records

string

Query

ipAddress_domainName
required

IP Address of this domain

string

Query

page
required

Total pages

integer(int32)

Query

q
required

Search string

string

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

toDate
required

Ending date for fetching records

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.27. Subnet Groups List

GET /reports/listsubnetgroup
Description

Provides a list of existing subnet groups for auditing purposes.

Example Http Request
https://example.com:7443/tims/rest/reports/listsubnetgroup  
Example Http Response
Content-Type : application/json
Content-Length : 252
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/listsubnetgroup  
Parameters
Type Name Description Schema

Query

page
required

Total pages

integer(int32)

Query

q
required

Search string

string

Query

rows
required

Rows per page

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.28. Monitoring Alerts CVS Report

POST /reports/monitalertcsvreport
Description

Provides a csv file for Daily, Weekly and Monthly Monitoring Alerts audit reports present in the TCPWave IPAM.

Parameters
Type Name Description Schema

Query

fromDate
required

Starting date for fetching records

string

Query

ipAddress_domainName
required

IP Address of this domain

string

Query

service_name
required

Service name

string

Query

toDate
required

Ending date for fetching records

string

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-9314: Export to CSV failed.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.9.29. Host List

GET /reports/monitoringhostslist
Description

Provides a list of existing hosts for monitoring purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/monitoringhostslist
Example Http Response
Content-Type : application/json
Content-Length : 4964"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/monitoringhostslist
Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.30. Monitoring Service List

GET /reports/monitoringserviceslist
Description

Provides a list of existing services for monitoring purposes.

Example Http Request
GET https://example.com:7443/tims/rest/reports/monitoringserviceslist
Example Http Response
Content-Type : application/json
Transfer-Encoding : chunked"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/monitoringserviceslist"
Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.31. Monitoring Alert Report List

GET /reports/monitreportlist
Description

Provides report details in grid for Daily, Weekly and Monthly Monitoring Alerts audit reports in the TCPWave IPAM.

Parameters
Type Name Description Schema

Query

fromDate
required

Starting date for fetching records

string

Query

ipAddress_domainName
required

IP Address of this domain

string

Query

page
required

Page number

integer(int32)

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

service_name
required

Name of Server used for monitoring

string

Query

toDate
required

Ending date for fetching records

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

500

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.32. Object Type List

GET /reports/objecttypelist
Description

Provides a list of existing object types for auditing purposes.

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.33. PDF Report

POST /reports/pdfreport
Description

Provides PDF format for the audit report in the TCPWave IPAM.

Parameters
Type Name Schema

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-9313: Current selection exceeds the allowable PDF size. Please modify your criteria or use CSV file download.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.9.34. Lists all Reports

GET /reports/reportlist
Description

Provides report details in grid for the audit reports in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/reports/reportlist?reportType=subnetListByGroupRpt&ipAddress_domainName=www.tcpwave.com.&fromDate=2015/07/01&toDate=2015/09/01&reportType=ResourseRecordAudit&page=1&rows=20  
Example Http Response
Content-Type : application/json
Content-Length : 21
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/reportlist?reportType=subnetListByGroupRpt&ipAddress_domainName=www.tcpwave.com.&fromDate=2015/07/01&toDate=2015/09/01&reportType=ResourseRecordAudit&page=1&rows=20  
Parameters
Type Name Description Schema

Query

filterRules
required

Filter rules

string

Query

fromDate
required

Starting date for fetching records

string

Query

ipAddress_domainName
required

IP Address of this domain

string

Query

page
required

Page number

integer(int32)

Query

q
required

Search string

string

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

toDate
required

Ending date for fetching records

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

500

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.35. Owner List

GET /reports/resourserecordauditlist
Description

Provides a list of existing owners and deleted owners for auditing purposes.

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.36. Schedule Report Email

POST /reports/sched_emailreport
Description

User can Schedule the time to email the report in PDF format to the email address of the contacts present in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

adminName
required

Name of Network Admin who is scheduling the email

string

Query

adminRole
required

Role of Admin (FADM/SADM/UADM/RADM)

string

Query

day
required

Day of Execution of scheduled operation

integer(int32)

Query

description
required

Desription about scheduled operation

string

Query

endtime
required

Ending time for execution of scheduled operation

string

Query

frequency
required

Frequency of scheduled operation

string

Query

repeat
required

Occurences of scheduled operation

integer(int32)

Query

repeatCount
required

Count for repetition of scheduled operation

integer(int32)

Query

repeatInterval
required

Time duration between repetition of scheduled operation

integer(int64)

Query

runtime
required

Execution time of scheduled operation

string

Query

starttime
required

Starting time for execution of scheduled operation

string

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.9.37. Administrator List

GET /reports/scheduleadminauditlist
Description

Provides a list of existing administrator and deleted administrator for auditing purposes.

Example Http Request
https://example.com:7443/tims/rest/reports/scheduleadminauditlist?actionType=active  
Example Http Response
Content-Type : application/json
Content-Length : 421
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/scheduleadminauditlist?actionType=active  
Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.38. CSV report

POST /reports/schedulecsvreport
Description

Provides a csv file for Scheduled Events Audit report present in the TCPWave IPAM.

Parameters
Type Name Schema

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-9314: Export to CSV failed.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.9.39. Schedule Events Audit Report

GET /reports/schedulereportlist
Description

Provides report details in grid for Schedule Events audit report in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/reports/schedulereportlist?fromDate=2016/12/01&toDate=2017/01/02&reportType=ScheduleAuditRpt&ipAddress_domainName=Event,Script,Callback,Rest,Patch,&userId=2042&page=1&rows=20
Example Http Response
Content-Type : application/json
Content-Length : 21"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/schedulereportlist?fromDate=2016/12/01&toDate=2017/01/02&reportType=ScheduleAuditRpt&ipAddress_domainName=Event,Script,Callback,Rest,Patch,&userId=2042&page=1&rows=20"
Parameters
Type Name Description Schema

Query

filterRules
required

Filter rule string

string

Query

fromDate
required

Starting date for fetching records

string

Query

ipAddress_domainName
required

IP Address of this domain

string

Query

jobId
required

ID of the current Job

string

Query

page
required

Total pages

integer(int32)

Query

q
required

Search string

string

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

toDate
required

Ending date for fetching records

string

Query

userId
required

ID of the active User

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

500

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.40. DNS Servers List

GET /reports/serverConfigReportlist
Description

Provides a list of existing DNS servers for auditing purposes.

Example Http Request
https://example.com:7443/tims/rest/reports/serverConfigReportlist  
Example Http Response
Content-Type : application/json
Content-Length : 1390
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/serverConfigReportlist  
Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.41. Server configuration audit report

GET /reports/serverConfigreportlist
Description

Provides report details in grid for Server configuration audit report in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/reports/serverConfigreportlist?ipAddress_domainName=10.1.10.180&server_type=Banner,NIC,SYSLOG,&fromDate=2015/07/01&toDate=2015/09/01&reportType=serverConfigurationAuditRpt&page=1&rows=20  
Example Http Response
Content-Type : application/json
Content-Length : 21
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/serverConfigreportlist?ipAddress_domainName=10.1.10.180&server_type=Banner,NIC,SYSLOG,&fromDate=2015/07/01&toDate=2015/09/01&reportType=serverConfigurationAuditRpt&page=1&rows=20  
Parameters
Type Name Description Schema

Query

filterRules
required

Filter rule string

string

Query

fromDate
required

Starting date for fetching records

string

Query

ipAddress_domainName
required

IP Address of this domain

string

Query

page
required

Total pages

integer(int32)

Query

q
required

Search string

string

Query

reportType
required

Report types (Network/subnet/object etc)

string

Query

rows
required

Rows per page

integer(int32)

Query

server_type
required

Type of the Server (DNS/DHCP)

string

Query

toDate
required

Ending date for fetching records

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.42. Server Configuration audit report CSV

POST /reports/serverconfigcsvreport
Description

Provides a csv file for Server Configuration audit report present in the TCPWave IPAM.

Parameters
Type Name Description Schema

Query

server_type
required

Type of the Server

string

Body

body
optional

Audit Report

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-9314: Export to CSV failed.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.9.43. Zone Data Audit Report

GET /reports/servertozonecount
Description

Provides report details in grid for Zone Data audit report in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/reports/servertozonecount
Example Http Response
Content-Type : application/json
Content-Length : 791"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/servertozonecount"
Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.44. Lists all Reports

GET /reports/viewsgridlist
Description

Provides report deatails in grid for the audit reports in the TCPWave IPAM.

Parameters
Type Name Description Schema

Query

filterRules
required

Filter rules

string

Query

fromDate
required

Starting date for fetching records

string

Query

org_id
required

Organization ID

integer(int32)

Query

page
required

Page number

integer(int32)

Query

q
required

Search string

string

Query

reportType
required

Report type of View Audit report)

string

Query

rows
required

Rows per page

integer(int32)

Query

toDate
required

Ending date for fetching records

string

Query

view_name
required

Name of the View

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListAudit Report Details

500

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.9.45. Zone Template List

GET /reports/zonetemplauditlist
Description

Provides a list of existing zone templates and deleted zone templates for auditing purposes.

Example Http Request
https://example.com:7443/tims/rest/reports/zonetemplauditlist?actionType=active  
Example Http Response
Content-Type : application/json
Content-Length : 2551
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/reports/zonetemplauditlist?actionType=active  
Parameters
Type Name Description Schema

Query

actionType
required

Action type

string

Responses
HTTP Code Description Schema

200

successful operation

< Audit Report Details > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.10. Authentication Configuration Service

4.10.1. Edit Authentication

POST /authconf/edit
Description

Modifies the TPCWave IPAM authentication configuration parameter values. Users can tune the behavior of the authentication mechanism to align with their organization security policy. Some of the paramters that can be modified from this interface includes - Minimum Password Length, Password Complexity ( 1- Alpha Numeric, 2 - Alpha Numeric with minimum one Capital Letter, 3 - Alpha Numeric with minimum one special character ), Allow Similar passwords as previous, Password Expiration time in days, Password reuse criteria, Maximum failed logins attempts by the user before the account is locked, whether a newly created user has to change password during first login, and the idle time out for session. Please refer to the TCPWave IPAM Administration Reference Manual for additional information.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Authentication Configuration

Responses
HTTP Code Description Schema

500

TIMS-7003: You are not authorized to perform this operation.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.10.2. Get Authentication Configuration

GET /authconf/get
Description

Obtains the current authentication configuration parameter values. For comprehensive list of the parameters and their significance, please refer to the TCPWave IPAM Administrator Reference Manual.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

Authentication Configuration

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.11. Authentication Token Management

Description

This service provides the API to list, generate, and deactivate authentication tokens in TCPWave IPAM. These tokens provide one way of securing the REST API to TCPWave IPAM from thrid party applications.

4.11.1. Session Token Deactivate

POST /auth_token/deactivate
Description

Deactivates a Session Token in the TCPWave IPAM . Functional Admin can deactivate any token in the sysem where as other admins can revoke only the tokens generated by them. Once revoked, the REST API calls from the external application using this token will no longer be authorized.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

< string > array

Responses
HTTP Code Description Schema

500

TIMS-7002: Permission information could not be retrieved.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • text/plain

4.11.2. Session Token Generate

POST /auth_token/generate
Description

Generates a new Session Token for integration with external tools. The generated token inherits the credentials of the user generating the token. The authencity of the caller is verified using the supplied password. Once generated the token is valid for a period defined by the global option till it is revoked using the deactivate service call.

Parameters
Type Name Schema

Body

body
optional

AuthTokenRequest

Responses
HTTP Code Description Schema

200

successful operation

Authentication Token Response

Consumes
  • application/json

  • application/xml

Produces
  • application/json

4.11.3. Get Auth Token

POST /auth_token/get
Description

An internal service call used by TCPWave IPAM GUI to generate a Session Token based on the current logged in users credentials. This call works only if there is a HTTPSession associated that is generated through TIMS login mechanism and hence not meant for external REST API integration.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Authentication Token

Responses
HTTP Code Description Schema

200

successful operation

Authentication Token Response

Consumes
  • application/json

  • application/xml

Produces
  • application/json

4.11.4. Session Token List

GET /auth_token/list
Description

Obtains a list of all the Session Tokens defined in the TCPWAVE IPAM. Functional Admin can list all the Session Tokens. Rest of the users can see only the session tokens that they generated.

Example Http Request
GET https://example.com:7443/tims/rest/auth_token/list
Example Http Response
Content-Type : application/json
Content-Length : 2326"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/auth_token/list"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< Authentication Token > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.12. Authentication Type

Description

This service provides the API to list the various authentication mechanisms supported by TCPWave IPAM and the current active mechanism selected. It also provides the interface to select a particular mechanism as the active authentication mechanism, provided the pre-conditions for that mechanism are satisfied.

4.12.1. Active Authentication Configuration

GET /authtype/getactive
Description

Gets the active authentication mechanism used by the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

Authentication Type

500

TIMS-7003: You are not authorized to perform this operation.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.12.2. Authentication Configuration List

GET /authtype/list
Description

Obtains a list of Authentication mechanisms supported in the TCPWave IPAM . Currently supported mechanisms include Kerberos-Active Directory, LDAP, PAM, RADIUS, TACACS+, and TIMS internal authentication mechanism.

Example Http Request
GET https://example.com:7443/tims/rest/authtype/list
Example Http Response
Content-Type : application/json
Content-Length : 617"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/authtype/list"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< Authentication Type > array

500

TIMS-4061: TACACS+ Server is not configured. TIMS-4064: RADIUS Server is not configured. TIMS-4067: LDAP Server is not configured. TIMS-4070: KERBEROS Key Distribution Center (KDC) is not configured.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.12.3. Authentication Set Active

POST /authtype/setactive
Description

Sets a given authentication mechanism as active in the TCPWave IPAM. This property can be changed only by the UADM or a FADM. The call will succeed only if the necessary conditions for the authentication mechanism are defined in the global options and are functional. For comprehensive list of the supported authentication mechanisms, please refer to the TCPWave IPAM Administrator Reference Manual.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

code
required

Authentication Code

string

Responses
HTTP Code Description Schema

500

TIMS-4000: Invalid authentication type code specified.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.13. Authorization Information

Description

This service provides the API to list and manage the permissions to network elements in TCPWave IPAM.

4.13.1. Add permissions to an entity

POST /permission/add
Description

Manages the permissions on an Object, Subnet, Network, or a Subnet Group for Admins and Admin Groups. Input is specified as AuthorizationInfo structure of the following format - target_type = Identifies the resource for which permissions are being granted. It is a single character that can take the following valid values -'N' (Network), 'S' (Subnet), 'O' (Object), and 'G' (Subnet Group) The instances of the entity for which the permissions are being granted are specified using either target_ids 'or' target_names. Using target_ids we can identify the instance using the internal database ID of the instance. This is generally used from the GUI where the ID information is already available. From CLI and External Applications target_names will be used to identify the instance. In case of Network and Subnet the start address is specified, and for Object the address of the object is specified, and in case of the Subnet Group, the group name is specified. groups - List of Admin groups that are granted with the permissions admins - List of Admins that are granted with the permissions. The previous permissions on the resources are removed and permissions are granted to the specified admins and admin groups.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

org_id
required

organization ID

integer(int32)

Query

org_name
required

organization name

string

Body

body
optional

Permission Information

Responses
HTTP Code Description Schema

500

TIMS-4011: Target type is not valid, TIMS-4012: Admin group is not valid.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.13.2. Permissions List

GET /permission/list
Description

Obtains a list of permissions associated with an entity. Returns the list of users and admin groups from the organization that the entity belongs to and the permissions that the entity has in the TCPWave IPAM. This is used in the TCPWave IPAM GUI Edit Permissions screen to show the existing permissions and allow for a change of permissions. The permissions are marked if they are derived permissions - eg., permissions on an object inherited from the permission on a subnet or network, and if the permissions are granted to the individual admin or at a admin group level.

Example Http Request
https://example.com:7443/tims/rest/permission/list?target_type=O&target_name=1.0.0.10&org_name=Internal  
Example Http Response
Content-Type : application/json
Content-Length : 156
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/permission/list?target_type=O&target_name=1.0.0.10&org_name=Internal  
Parameters
Type Name Description Schema

Query

org_id
required

organization ID

integer(int32)

Query

org_name
required

organization name

string

Query

target_id
required

target entity id(i.e Network ID)

integer(int32)

Query

target_name
required

target entity name(i.e Network name)

string

Query

target_type
required

entity type N(network)/S(sub-net)/G(subnetgroup)/O(object)

string

Responses
HTTP Code Description Schema

200

successful operation

Permission Information

500

TIMS-1100: Both Organization Id and Organization Name cannot be null, TIMS-1101: Cannot find organization, TIMS-1100: Both Target Id and Target Name cannot be null, TIMS-1100: Cannot find target.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.13.3. Permissions View

GET /permission/view
Description

Lists the Admins and Admin Groups that have permissions on the given entity. This is used in the TCPWave IPAM GUI to show read-only view of the permissons. The permissions are marked if they are derived permissions - eg., permissions on an object inherited from the permission on a subnet or network, and if the permissions are granted to the individual admin or at a admin group level.

Parameters
Type Name Description Schema

Query

org_id
required

organization ID

integer(int32)

Query

org_name
required

organization name

string

Query

target_id
required

entity id (i.e Network ID)

integer(int32)

Query

target_name
required

entity name (Name of the subnet group or address of Network/Subnet/Object)

string

Query

target_type
required

entity type N(network)/S(sub-net)/G(subnetgroup)/O(object)

string

Responses
HTTP Code Description Schema

200

successful operation

Permission Information

500

TIMS-1100: Both Organization Id and Organization Name cannot be null, TIMS-1101: Cannot find organization, TIMS-1100: Both Target Id and Target Name cannot be null, TIMS-1100: Cannot find target

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.14. Bookmark Service

Description

This service provides API's to obtain list of bookmarks defined in the TCPWave IPAM by the user and to create a new bookmark in the TCPWave IPAM.

4.14.1. Add bookmark

POST /bookmark/add
Description

Creates a new bookmark in the TCPWave IPAM. Bookmark is a shortcut created by user for easy navigation. These bookmarks are displayed in the left side navigation menu of the TCPWave IPAM GUI screens and will take the control to the bookmarked screen when clicked. Bookmarks can be placed on Networks, Subnets, and Objects and are created selecting create book mar menu item on the context-menu. Bookmarks are used from within TCPWave IPAM GUI.

Parameters
Type Name Schema

Body

body
optional

Bookmark

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.14.2. Delete bookmark

POST /bookmark/delete
Description

Deletes a bookmark previously created in the TCPWave IPAM by the user.

Parameters
Type Name Description Schema

Query

id
required

ID of the selected record

integer(int32)

Query

type
required

Type of the selected record (i.e. Network)

string

Query

user
required

current logged-in User Name

string

Query

value
required

Information of selected record (i.e. 10.1.11.0/24:7936)

string

Responses
HTTP Code Schema

500

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.14.3. Get Bookmark List

GET /bookmark/list
Description

Obtains a list of bookmarks defined in the TCPWave IPAM by the user. Bookmark is a shortcut created by user for easy navigation.

Example Http Request
GET https://example.com:7443/tims/rest/bookmark/list?user=twcadm
Example Http Response
Content-Type : application/json
Content-Length : 2"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/bookmark/list?user=twcadm"
Parameters
Type Name Description Schema

Query

user
required

current logged-in User Name

string

Responses
HTTP Code Description Schema

200

successful operation

< Tree Node > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.15. Central Logging Service

Description

This serivce provides the information related to the Central logging facility in TCPWave IPAM.

4.15.1. Central Logging Configuration

GET /centralLogging/centralLoggingConfig
Description

Returns the current Central Logging Configuration settings in the TCPWAVE IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/centralLogging/centralLoggingConfig
Example Http Response
Content-Type : application/json
Content-Length : 422"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/centralLogging/centralLoggingConfig"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

CentralLoggingConfig

500

TIMS-8609: Configuration type is either null or empty.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.15.2. Central Logging Configuration

GET /centralLogging/centralLoggingFullConfig
Description

Returns the current Central Logging Configuration settings, including the different server types logging settings in the TCPWAVE IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/centralLogging/centralLoggingFullConfig
Example Http Response
Content-Type : application/json
Content-Length : 5996"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/centralLogging/centralLoggingFullConfig"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

CentralLoggingFullConfig

500

TIMS-8601: Configuration type is null, TIMS-8602: Configuration type is empty.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.15.3. Central Logging Server Logs

GET /centralLogging/centralLoggingServerLogConfig
Description

Returns the current Cental Logging Configuration settings for a particular server type in the TCPWAVE IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/centralLogging/centralLoggingServerLogConfig?serverType=DNS
Example Http Response
Content-Type : application/json
Content-Length : 2130"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/centralLogging/centralLoggingServerLogConfig?serverType=DNS"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

serverType
required

Server Type

string

Responses
HTTP Code Description Schema

200

successful operation

< CentralLoggingServerLog > array

500

TIMS-8610: Server type is either null or empty. 8604: Server type is null. TIMS-8605: Server type is empty.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.15.4. Update Central Logging Configuration Information.

POST /centralLogging/fullConfigUpdate
Description

Updates the Central Logging Configuration in the TCPWAVE IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

CentralLoggingFullConfig

Responses
HTTP Code Description Schema

500

TIMS-8601: Configuration type is null, TIMS-8602: Configuration type is empty, TIMS-8603: Configuration type does not exist.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

  • text/plain

4.15.5. Server Central Logging Setting

GET /centralLogging/serverCentralLoggingSetting
Description

The Central Logging Service provides the functionality to send different IPAM logs to a data collection server, like Flume Agent.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

IP Address of the selected Server

string

Query

clogOption
required

Central Logging Option parameter

string

Query

serverType
required

Type of the Server (DNS/DHCP)

string

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-8611: Central Logging is not configured on the IPAM server. Please configure it first, TIMS-8612: Central Logging feature is not implemented.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

  • text/plain

4.16. Certificate Management Service

Description

This class provides services related to Certificate management such as import, delete, list certificates in TCPWave IPAM. It also provides validity related information of a certificate.

4.16.1. Get number of days all certificates are valid

GET /certmgmt/allcertValidDays
Description

Retrieve the number of days the server certificates are valid for in the TCPWave IPAM. Refer Administrator Reference document for more information.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< JSONObject > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.16.2. Certificate Delete

POST /certmgmt/certDelete
Description

Deletes a Secure Socket Layer (SSL) certificate from in the TCPWave IPAM. SSL certificates are primarily used to secure the communication between two end points.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

string

Responses
HTTP Code Description Schema

500

TIMS-8307: This certificate cannot be deleted as it is the only certificate in the keystore.

No Content

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.16.3. Import Certificate

POST /certmgmt/certImport
Description

Imports a new Secure Socket Layer (SSL) certificate into in the TCPWave IPAM. SSL certificates are primarily used to secure the communication between two end points.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

string

Responses
HTTP Code Description Schema

500

TIMS-8317: Please enter Certificate file.

No Content

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.16.4. Number of days Certificate is valid for

GET /certmgmt/certValidDays
Description

Provides the number of days that a Secure Socket Layer (SSL) certificates is valid for. SSL certificates are primarily used to secure the communication between two end points.

Example Http Request
GET https://example.com:7443/tims/rest/certmgmt/certValidDays
Example Http Response
Content-Type : application/json
Content-Length : 1"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/certmgmt/certValidDays"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

integer(int64)

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.16.5. Certificate validation

GET /certmgmt/certValidate
Description

Validates a given Secure Socket Layer (SSL) certificate defined in the TCPWave IPAM. SSL certificates are primarily used to secure the communication between two end points.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

cfile
required

Certificate File

string

Responses
HTTP Code Description Schema

200

successful operation

Certificate

500

TIMS-8304: Certificate is not valid.

No Content

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.16.6. certificate list

GET /certmgmt/certlist
Description

Obtains a list of all the Secure Socket Layer (SSL) certificates defined in the TCPWave IPAM. SSL certificates are primarily used to secure the communication between two end points.

Example Http Request
GET https://example.com:7443/tims/rest/certmgmt/certlist
Example Http Response
Content-Type : application/json
Content-Length : 3794"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/certmgmt/certlist"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< Certificate > array

500

TIMS-8303: Certificate get list failed.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.16.7. Change Keystore Password

POST /certmgmt/changeKeystorePassword
Description

Change the Server keystore password in the TCPWave IPAM. For more information on managing the TCPWave Server Certificates, please refer to the Administrator Reference document.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

string

Responses
HTTP Code Description Schema

500

TIMS-8308: An error occured while changing the certificate store password.

No Content

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.16.8. Duplicate Alias check

POST /certmgmt/duplicateAlias
Description

Data Integrity check defined in the TCPWave IPAM to check if a Secure Socket Layer (SSL) certificate has a duplicate definition. SSL certificates are primarily used to secure the communication between two end points.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.16.9. Web Server Restart

POST /certmgmt/jettyRestart
Description

As a part of the certificate management logic, a restart of the Web server is required to put the property up certificate into use. This API call restarts the embedded.web server.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

500

TIMS-8102: Server address is empty, TIMS-8101: Service to restart jetty server is not defined.

No Content

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.17. Checkouts Service Details

Description

This service provides REST API access to retrive the TCPWave checkouts results in the IPAM. The TCPWave Checkouts operations are performed against the TCPWave IPAM and TCPWave remotes in scheduled intervals. The default schedule interval is 12 hours and this can be changed in the TCPWave Scheduler page. The checkouts results are stored centrally in the TCPWave IPAM appliance as json format files. These checkout results can be accessed from the TCPWave Web Interface.

4.17.1. DHCP Server checkouts information

GET /checkouts/list/dhcp/{server_ip}
Description

Gets the checkouts information of remote DHCP in the TCPWave IPAM. Checkouts information is the list of various checkouts performed on remote DHCP at regular intervals defined in the scheduler tasks.

Example Http Request
GET https://example.com:7443/tims/rest/checkouts/list/dns/163.35.10.57
Example Http Response
Content-Type : application/json
Content-Length : 0"	
Status code : 204
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/checkouts/list/dns/163.35.10.57"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Path

server_ip
required

IP Address of the DHCP Server

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.17.2. DNS server’s checkouts information

GET /checkouts/list/dns/{server_ip}
Description

Gets the checkouts information of remote DNS in the TCPWave IPAM. Checkouts information is the list of various checkouts performed on remote DNS at regular intervals defined in the scheduler tasks.

Example Http Request
GET https://example.com:7443/tims/rest/checkouts/list/dns/169.191.96.15
Example Http Response
Content-Type : application/json
Content-Length : 0"	
Status code : 204
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/checkouts/list/dns/169.191.96.15"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Path

server_ip
required

IP Address of the DNS Server

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.17.3. Get IPAM checkouts information

GET /checkouts/list/ipam
Description

Gets the checkouts information of TCPWave IPAM. Checkouts information is the list of various checkouts performed on IPAM server at regular intervals defined in the scheduler tasks. The information includes metadata(Information about checkout operation), sysinfo checkouts(System information details), basic checkouts(System health) and service checkouts(TCPWave IPAM Services health).

Example Http Request
GET https://example.com:7443/tims/rest/checkouts/list/ipam
Example Http Response
Content-Type : application/json
Content-Length : 0"	
Status code :204
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/checkouts/list/ipam"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.18. Class Code Logo Service

Description

This service provides the logos for various object types in TCPWave IPAM.

4.18.1. Class Code Logo List

GET /classCodeLogo/list
Description

Obtains a list of all the logos of the object types present in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/classCodeLogo/list
Example Http Response
Content-Type : application/json
Content-Length : 3755"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/classCodeLogo/list"
Responses
HTTP Code Description Schema

200

successful operation

< Class Code Logo > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.19. Class Code Service

Description

This class provides services related to Object Type such as Add, Delete and Update Object type in TCPWave IPAM. It also provides a list of all available Object types in TCPWave IPAM.

4.19.1. Object Type Add

POST /classcode/add
Description

Creates a new object type in the TCPWave IPAM . These are used to create objects in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/classcode/add  -POST  {"code":"Local Server","description":"A Generic Web Server"}
Example Http Response
Content-Type : application/json
Content-Length : null
Status code :200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/classcode/add  -d  '{"code":"Local Server","description":"A Generic Web Server"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Class Code

Responses
HTTP Code Description Schema

500

TIMS 2030: Class Type already exists.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.19.2. Object Type Delete

POST /classcode/delete
Description

Deletes an existing object type in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/classcode/delete  -POST  {"code":"Web Server"}
Example Http Response
Content-Type : application/json
Content-Length : 60
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/classcode/delete  -d  '{"code":"Web Server"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Class Code

Responses
HTTP Code Description Schema

500

TIMS-2020: Object Type does not exist.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.19.3. Class Code Details

POST /classcode/get
Description

Obtains a list of class codes that have been pre-defined in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Class Code

Responses
HTTP Code Description Schema

200

successful operation

Class Code

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.19.4. Object Type List

GET /classcode/list
Description

Obtains a lists of all the Object Types available in the TCPWave IPAM . These are used to create objects in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/classcode/list?page=1&rows=10  
Example Http Response
Content-Type : application/json
Content-Length : 657
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/classcode/list?page=1&rows=10  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< Class Code > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.19.5. Object Type Update

POST /classcode/update
Description

Edits an existing object type in the TCPWave IPAM. These are used to create objects in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/classcode/update  -POST  {"code":"Web Server1","description":"A Generic Web Server","old_class_code":"Server"}
Example Http Response
Content-Type : application/json
Content-Length : 23
Status code :200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/classcode/update  -d  '{"code":"Web Server1","description":"A Generic Web Server","old_class_code":"Server"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Class Code

Responses
HTTP Code Description Schema

500

TIMS-2020: Object Type does not exist.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.20. Cloud DNS Provider Service

Description

This service class provides services related to Cloud DNS Provider such as add/edit/del Cloud Provider, list Cloud Providers, list Cloud Provider Templates, list Cloud Provider Types, update Cloud Provider Templates in TCPWave IPAM.

4.20.1. Add New Cloud Provider

POST /clouddnsprovider/add
Description

Add new Cloud Provider in the TCPWave IPAM.One Cloud Provider can be associated with multiple DNS Zone Templates.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

DNS Cloud Provider

Responses
HTTP Code Description Schema

500

TIMS-9411: Both Provider id and Zone Template id are null.

No Content

Consumes
  • application/json

Produces
  • application/json

  • application/xml

4.20.2. Delete Cloud Provider

POST /clouddnsprovider/delete/{name}
Description

Delete existing Cloud Providers in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Path

name
required

Cloud Provider Name required to delete

string

Responses
HTTP Code Description Schema

500

TIMS-9411: Both Provider id and Zone Template id are null. TIMS-9415: Provider is used in templates. Please dissociate those templates from the provider and try again.

No Content

Produces
  • application/json

  • application/xml

  • text/plain

4.20.3. Disassociate Cloud Provider

POST /clouddnsprovider/disassociate
Description

Disassociate the Cloud Provider from a DNS Zone template defined in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

cpid
required

Cloud Provider Id required for disassociating Cloud Provider from Zone

integer(int32)

Query

cpname
required

Cloud Provider Name required for disassociating Cloud Provider from Zone

string

Query

cptype
optional

Cloud Provider Type required for disassociating Cloud Provider from Zone

string

Query

org_id
required

Organization Id required for disassociating Cloud Provider from Zone

integer(int32)

Query

org_name
optional

Organization Name required for disassociating Cloud Provider from Zone

string

Body

body
optional

< DNS Cloud Provider Template > array

Responses
HTTP Code Description Schema

500

TIMS-9411: Both Provider id and Zone Template id are null.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.20.4. Edit Cloud Provider

POST /clouddnsprovider/edit
Description

Edit existing Cloud Providers in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

oldname
required

Cloud Provider Name required to modify exixting Cloud Provider

string

Body

body
optional

DNS Cloud Provider

Responses
HTTP Code Description Schema

500

TIMS-9406: Both Provider name and id cannot be null. TIMS-9407: Provider name is not valid. TIMS-9408: Provider id is not valid. TIMS-7003: You are not authorized to perform this operation.

No Content

Consumes
  • application/json

Produces
  • application/json

  • application/xml

4.20.5. Cloud Provider List

GET /clouddnsprovider/list
Description

Obtains a list of all the cloud providers defined in the TCPWave IPAM. A cloud provider is an instanc e of the cloud provider type with the associated credentials to manage the data in the cloud. Please refer to TCPWave IPAM Administrator Guide for a comprehensive list of cloud provider types supported.

Example Http Request
GET https://example.com:7443/tims/rest/clouddnsprovider/list?org_name=EARTH
Example Http Response
Content-Type : application/json
Content-Length : 2"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/clouddnsprovider/list?org_name=EARTH"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

org_id
required

Organization Id required for listing all cloud providers.

integer(int32)

Query

org_name
required

Organization name required for listing all cloud providers associated with that Organization.

string

Responses
HTTP Code Description Schema

200

successful operation

< DNS Cloud Provider > array

500

TIMS-1020: Both Organization name and id cannot be null, TIMS-1021: Organization name is not valid, TIMS-1025: Organization id is not valid, TIMS-7003: You are not authorized to perform this operation.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.20.6. Cloud Provider Templates

GET /clouddnsprovider/list_provider_templates
Description

Obtains a mapping of the cloud providers to the zone templates defined in the TCPWave IPAM. This mapping is used by TCPWave IPAM DNS module to keep the data in sync in the selected cloud.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

provider
required

Organization Id required for listing all cloud providers template

string

Query

template
required

Organization name required for listing all cloud providers templates

string

Responses
HTTP Code Description Schema

200

successful operation

< DNS Cloud Provider Template > array

500

TIMS-9411: Both Provider id and Zone Template id are null.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.20.7. Cloud Provider Types

GET /clouddnsprovider/list_provider_types
Description

Lists the Cloud Provider Types defined in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/clouddnsprovider/list_provider_types?org_name=EARTH
Example Http Response
Content-Type : application/json
Content-Length : 7934"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/clouddnsprovider/list_provider_types?org_name=EARTH"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< DNS Cloud Provider Type > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.20.8. Cloud DNS update template

POST /clouddnsprovider/update_template
Description

Updates the Cloud Provider for any DNS Zone template defined in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

name
required

Template name required to update the template

string

Query

org_id
required

Organization Id required to update the template

integer(int32)

Query

org_name
optional

Organization Name required to update the template

string

Query

type
required

string

Body

body
optional

< string > array

Responses
HTTP Code Description Schema

500

TIMS-9411: Both Provider id and Zone Template id are null. TIMS-9412: Provider name or Zone Template name is not valid.

No Content

Consumes
  • application/json

Produces
  • application/json

  • application/xml

4.21. Contact Service

Description

This serivce provides the information related to the Contacts associated with TCPWave IPAM such as get,edit,delete,update list contacts etc.

4.21.1. Contact Add

POST /contact/add
Description

Creates a new contact in the TCPWave IPAM. Only Functional Admin can create contacts in any organizations. Rest of the admins can create contacts only in the organizations that they belong to.

Example Http Request
https://example.com:7443/tims/rest/contact/add  -POST  {"organization_name":"Internal","first_name":"John","last_name":"Smith","email_id":"john.smith@tcpwave.com","phone_num":"920-310-5555"}
Example Http Response
Content-Type : application/json
Content-Length : null
Status code :200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/contact/add  -d  '{"organization_name":"Internal","first_name":"John","last_name":"Smith","email_id":"john.smith@tcpwave.com","phone_num":"920-310-5555"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Contacts Information

Responses
HTTP Code Description Schema

500

TIMS-1321: Both organization name and id cannot be null, TIMS-1322: Cannot find the organization, TIMS-1323: invalid email address specified.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.21.2. Contact List based on Roles

GET /contact/auditroleslist
Description

Obtains a list of all the Contacts based on selected user role defined and managed in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/contact/auditroleslist?roles=FADM
Example Http Response
Content-Type : application/json
Content-Length : 653"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/contact/auditroleslist?roles=FADM"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

roles
required

User Role required to list the contacts

string

Responses
HTTP Code Description Schema

200

successful operation

< Contacts Information > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.21.3. Contact Delete

POST /contact/delete
Description

Deletes an existing contact in the TCPWave IPAM. Functional Admin can delete contacts belonging to any organization. Rest of the admins can delete contacts belonging to their organization only.

Example Http Request
https://example.com:7443/tims/rest/contact/delete  -POST  {"organization_name":"Internal","first_name":"John","last_name":"Smith","email_id":"john.smith@tcpwave.com"}
Example Http Response
Content-Type : application/json
Content-Length : 45
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/contact/delete  -d  '{"organization_name":"Internal","first_name":"John","last_name":"Smith","email_id":"john.smith@tcpwave.com"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Contacts Information

Responses
HTTP Code Description Schema

500

TIMS-1331: Cannot find organization, TIMS-1332: Cannot find contact for the given criteria.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.21.4. Contact Delete Multiple

POST /contact/deleteAll
Description

Deletes all the specified contacts present in the TCPWave IPAM . Functional Admin can delete contacts belonging to any organization. Rest of the admins can delete contacts belonging to their organization only.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

List of contacts to be deleted

< Contacts Information > array

Responses
HTTP Code Description Schema

500

TIMS-1332: Cannot find contact for the given criteria.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.21.5. Get Contact Information

POST /contact/get
Description

Provides the information of the contacts present in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/contact/get  -POST  {"organization_name":"TCPWave","first_name":"John","last_name":"Smith","email_id":"john.smith@tcpwave.com"}
Example Http Response
Content-Type : application/json
Content-Length : 60
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/contact/get  -d  '{"organization_name":"TCPWave","first_name":"John","last_name":"Smith","email_id":"john.smith@tcpwave.com"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Contacts Information

Responses
HTTP Code Description Schema

200

successful operation

Contacts Information

500

TIMS-1352: Organization does not exist, TIMS-1202: Contact does not exist.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.21.6. Contact List

GET /contact/list
Description

Obtains a list of all the Contacts defined and managed by the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/contact/list
Example Http Response
Content-Type : application/json
Transfer-Encoding : chunked"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/contact/list"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< Contacts Information > array

500

TIMS-7003: You are not authorized to perform this operation.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.21.7. Contact List Associated with an Organization

GET /contact/list/{organization_id}
Description

Obtains a list of all the Contacts associated with an Organization defined and managed by the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/contact/list/1597
Example Http Response
Content-Type : application/json
Content-Length : 2"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/contact/list/1597"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Path

organization_id
required

Organization ID required for Listing all Contacts associated with that organization

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

< Contacts Information > array

500

TIMS-7003: You are not authorized to perform this operation.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.21.8. Contact List for selected User Roles

GET /contact/roleslist
Description

Obtains a list of all the Contacts based on selected user role defined and managed by the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

roles
required

User Roles required to list the contacts

string

Responses
HTTP Code Description Schema

200

successful operation

< Contacts Information > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.21.9. Search Contacts

GET /contact/search
Description

Searches for the Contacts present in the TCPWave IPAM.

Parameters
Type Name Description Schema

Query

page
optional

Total page

integer(int32)

Query

rows
optional

Rows per page/Page Size

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListContacts Information

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.21.10. Contact Update

POST /contact/update
Description

Edits an existing contact in the TCPWave IPAM. Only Functional Admin can modify contacts in any organizations. Rest of the admins can create contacts only in the organizations that they belong to.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

email
optional

Email

string

Query

first_name
optional

First Name

string

Query

last_name
optional

Last Name

string

Body

body
optional

Contacts Information

Responses
HTTP Code Description Schema

500

TIMS-1323: invalid email address specified.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.22. DHCP Active Lease Service

Description

This service class provides Active Lease of a DHCP Server in TCPWave IPAM.

4.22.1. Get Active Leases

GET /dhcpActiveLeases/getActiveLeases
Description

Provides all the Active Leases for a given IPv4 DHCP servers in TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/dhcpActiveLeases/getActiveLeases?serverAddress=163.35.10.57
Example Http Response
Content-Type : application/json
Content-Length : 2"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpActiveLeases/getActiveLeases?serverAddress=163.35.10.57"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

serverAddress
required

DHCP Server Address

string

Responses
HTTP Code Description Schema

200

successful operation

< DHCP Lease Data > array

500

TIMS-4017: Auth token is not specified, TIMS-4016: Auth token has expired, TIMS-7003: You are not authorized to perform this operation.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.23. DHCP Class Service

Description

This service class provides facility to add, modify, delete, list DHCP Client class in TCPWave IPAM.

4.23.1. Create DHCP Class

POST /dhcpclass/add
Description

Creates an IPv4 DHCP Client class, User class and Vendor class definitions.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

DHCPClass

Responses
HTTP Code Description Schema

500

TIMS-2027: DHCP class with the given match expression already exists, TIMS-2028: DHCP class with the given name already exists.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.23.2. DHCP Classes Delete

POST /dhcpclass/delete
Description

Deletes an IPv4 DHCP class definition, provided there are no DHCP Scopes using it.

Example Http Request
https://example.com:7443/tims/rest/dhcpclass/delete?name=vendor-class-y&entityType=VENDOR  -POST
Example Http Response
Content-Type : application/json
Content-Length : null
Status code :200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dhcpclass/delete?name=vendor-class-y&entityType=VENDOR  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

entityType
required

Required Entity Type

string

Query

id
required

Required Entity Id

integer(int32)

Query

name
required

DHCP Class Name

string

Responses
HTTP Code Description Schema

500

TIMS-1371: Cannot delete this class as it is being usedby one or more scopes, TIMS-7003: You are not authorized to perform this operation, TIMS-1371: Cannot delete this class as it is being used by one or more scopes.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.23.3. DHCP Class Edit

POST /dhcpclass/edit
Description

Edits a given IPv4 DHCP class definition. The class name and the match expression can be edited.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

DHCPClass

Responses
HTTP Code Description Schema

500

TIMS-7003: You are not authorized to perform this operation, TIMS-2027: DHCP class with the given match expression already exists.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.23.4. DHCP Class List

GET /dhcpclass/list
Description

Obtains a list of all the IPv4 DHCP class definitions defined in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/dhcpclass/list?entityType=CLIENT  
Example Http Response
Content-Type : application/json
Content-Length : 2
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpclass/list?entityType=CLIENT  
Parameters
Type Name Description Schema

Query

entityType
required

Entity Type

string

Responses
HTTP Code Description Schema

200

successful operation

< DHCPClass > array

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.24. DHCP Server Service

Description

This class provides list of all avaialable DHCP Servers, Primary Servers and Failover Servers in TCPWave IPAM. User can add, edit or delete DHCP Server in TCPWave IPAM. TCPWave IPAM supports user to check DHCP Server/DHCP Failover Server Configuration and to generate DHCP Server Configuration. IT also provides the heartbeat of alive Servers.

4.24.1. DHCP Server Create

POST /dhcpserver/add
Description

Creates an IPv4 DHCP Server in TCPWave IPAM. User will have the ability to define a Primary/Failover IPv4 DHCP Server and configure Time Zone, Banner, NTP, SNMP, Tacacs, Syslog and MAC Exclusions to it.

Example Http Request
https://example.com:7443/tims/rest/dhcpserver/add  -POST  {"server":{"serverPreference":"Primary","v4_ipaddress":"1.1.0.5","old_address":"","name":"test-dns","domain_name":"10free.jpnbhgj","description":"test-dhcp-server","dhcp_policy_template_id":"41013","option":"no","monitoringService":"yes","server_type":"DHCP","created_by":"1978","banner":"DHCP-Africa","snmpConfig":"{"trapSink1":"1.1.1.9","trapSink2":"1.1.1.77","communityString":"ABC123","systemLocation":"sOUTH aFRICA","systemContact":"378832","systemName":"test-dns.10free.jpnbhgj","processes":"ntpd-0/dns-0/crond-0/sshd-0/monit-0/rsyslog-0/dhcpd-1"}","timeZone":"Africa/Accra","syslogConfig":"[{"action":"/var/log/messages","active":"yes","selector":"*.info;mail.none;authpriv.none;cron.none"},{"action":"/var/log/secure","active":"yes","selector":"authpriv.*"},{"action":"-/var/log/maillog","active":"yes","selector":"mail.*"},{"action":"/var/log/cron","active":"yes","selector":"cron.*"},{"action":":omusrmsg:*","active":"yes","selector":"*.emerg"},{"action":"/var/log/spooler","active":"yes","selector":"uucp,news.crit"},{"action":"/var/log/boot.log","active":"yes","selector":"local7.*"}]","ntpConfig":"1.1.1.1"}}
Example Http Response
Content-Type : application/json
Content-Length : 23
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dhcpserver/add  -d  '{"server":{"serverPreference":"Primary","v4_ipaddress":"1.1.0.5","old_address":"","name":"test-dns","domain_name":"10free.jpnbhgj","description":"test-dhcp-server","dhcp_policy_template_id":"41013","option":"no","monitoringService":"yes","server_type":"DHCP","created_by":"1978","banner":"DHCP-Africa","snmpConfig":"{"trapSink1":"1.1.1.9","trapSink2":"1.1.1.77","communityString":"ABC123","systemLocation":"sOUTH aFRICA","systemContact":"378832","systemName":"test-dns.10free.jpnbhgj","processes":"ntpd-0/dns-0/crond-0/sshd-0/monit-0/rsyslog-0/dhcpd-1"}","timeZone":"Africa/Accra","syslogConfig":"[{"action":"/var/log/messages","active":"yes","selector":"*.info;mail.none;authpriv.none;cron.none"},{"action":"/var/log/secure","active":"yes","selector":"authpriv.*"},{"action":"-/var/log/maillog","active":"yes","selector":"mail.*"},{"action":"/var/log/cron","active":"yes","selector":"cron.*"},{"action":":omusrmsg:*","active":"yes","selector":"*.emerg"},{"action":"/var/log/spooler","active":"yes","selector":"uucp,news.crit"},{"action":"/var/log/boot.log","active":"yes","selector":"local7.*"}]","ntpConfig":"1.1.1.1"}}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

DHCP Server

Responses
HTTP Code Description Schema

500

TIMS-3030: Both object id and ip address cannot be null, TIMS-3033: A server already exists with the specified address, TIMS-3031: Specified object not found, TIMS-3036: Both DHCP Policy Template name and id can not be null, TIMS-3037: Specified DHCP Policy Template not found, TIMS-3038: Invalid Server Type specified, TIMS-3039: Cannot create a server using a DHCP object.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.24.2. DHCP Server Debugger

GET /dhcpserver/debugger
Description

Logging mechanism that allows a more verbose logging for investigating purposes in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

duration
optional

Time Duration

integer(int32)

Query

hardware
required

Hardware

string

Query

server
required

DHCP Server Name

string

Responses
HTTP Code Description Schema

200

successful operation

DHCP Debugger

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.3. DHCP Server Delete

POST /dhcpserver/delete
Description

Deletes a given IPv4 DHCP Server, Provided it does not serve any DHCP enabled subnets.

Example Http Request
https://example.com:7443/tims/rest/dhcpserver/delete?address=9.0.0.6  -POST
Example Http Response
Content-Type : application/json
Content-Length : 41
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dhcpserver/delete?address=9.0.0.6  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

IP address of the selected Server

string

Query

id
required

integer(int32)

Responses
HTTP Code Description Schema

500

TIMS-1368: Cannot delete the DHCP Server as it manages one or more subnets, TIMS-1369: Cannot delete the DHCP Server as it manages one or more scopes, TIMS-1370: Cannot delete the DHCP Server, as it’s a failover to a DHCP server, TIMS-1371: Cannot delete the DHCP Server, as there are Manual-DHCP Objects associated to it, TIMS-1360: Specified server not found. <Server address>, TIMS-1359: Both server id and address can not be null.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.24.4. DHCP Server’s Active Leases

GET /dhcpserver/dhcpActiveLeases
Description

Obtains a list of IPv4 DHCP server’s active leases defined and managed by the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/dhcpserver/dhcpActiveLeases?serverIp=1.0.0.5  
Example Http Response
Content-Type : application/json
Content-Length : 21
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/dhcpActiveLeases?serverIp=1.0.0.5  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

serverIp
required

Required Server’s IP address

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListDHCP Lease Data

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.5. DHCP Server Update

POST /dhcpserver/edit
Description

Edits an IPv4 DHCP Server in TCPWave IPAM. User will have the ability to edit a Primary/Failover IPv4 DHCP Server and configure Time Zone, Banner, NTP, SNMP, Tacacs, Syslog and MAC Exclusions to it.

Example Http Request
https://example.com:7443/tims/rest/dhcpserver/edit  -POST {"server":{"serverPreference":null,"v4_ipaddress":"1.1.0.8","old_address":"1.1.0.8","name":"dhcp12","domain_name":"tcpwave-13.com","description":"Dhcp test ","dhcp_policy_template_id":"40941","option":"no","monitoringService":"no","server_type":"DHCP","updated_by":"1978","setFailoverFlag":false,"banner":"","ntpConfig":"1.0.0.0","snmpConfig":"{"trapSink1":"2.0.0.0","trapSink2":"3.0.0.0","communityString":"kjcksdjc","systemName":"dhcp12.tcpwave-13.com","processes":"ntpd-0/dns-0/crond-0/sshd-0/monit-1/rsyslog-1/dhcpd-0"}","tacacsConfig":"0-@-10.1.10.171|abc123","syslogConfig":"[{"action":"/var/log/messages","active":"yes","selector":"*.info;mail.none;authpriv.none;cron.none"},{"action":"/var/log/secure","active":"yes","selector":"authpriv.*"},{"action":"-/var/log/maillog","active":"yes","selector":"mail.*"},{"action":"/var/log/cron","active":"yes","selector":"cron.*"},{"action":"*","active":"yes","selector":"*.emerg"},{"action":"/var/log/spooler","active":"yes","selector":"uucp,news.crit"},{"action":"/var/log/boot.log","active":"yes","selector":"local7.*"}]","timeZone":"Africa/Abidjan"}}
Example Http Response
Content-Type : application/json
Content-Length : 0
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dhcpserver/edit  -d '{"server":{"serverPreference":null,"v4_ipaddress":"1.1.0.8","old_address":"1.1.0.8","name":"dhcp12","domain_name":"tcpwave-13.com","description":"Dhcp test ","dhcp_policy_template_id":"40941","option":"no","monitoringService":"no","server_type":"DHCP","updated_by":"1978","setFailoverFlag":false,"banner":"","ntpConfig":"1.0.0.0","snmpConfig":"{"trapSink1":"2.0.0.0","trapSink2":"3.0.0.0","communityString":"kjcksdjc","systemName":"dhcp12.tcpwave-13.com","processes":"ntpd-0/dns-0/crond-0/sshd-0/monit-1/rsyslog-1/dhcpd-0"}","tacacsConfig":"0-@-10.1.10.171|abc123","syslogConfig":"[{"action":"/var/log/messages","active":"yes","selector":"*.info;mail.none;authpriv.none;cron.none"},{"action":"/var/log/secure","active":"yes","selector":"authpriv.*"},{"action":"-/var/log/maillog","active":"yes","selector":"mail.*"},{"action":"/var/log/cron","active":"yes","selector":"cron.*"},{"action":"*","active":"yes","selector":"*.emerg"},{"action":"/var/log/spooler","active":"yes","selector":"uucp,news.crit"},{"action":"/var/log/boot.log","active":"yes","selector":"local7.*"}]","timeZone":"Africa/Abidjan"}}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

DHCP Server

Responses
HTTP Code Description Schema

500

TIMS-3030: Both object id and IP address cannot be null. TIMS-3031: Specified object is not found. TIMS-3036: Both DHCP Policy Template name and id cannot be null. TIMS-3037: Specified DHCP Policy Template not found.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.24.6. dhcp failover servers

GET /dhcpserver/failover-list
Description

Obtains a list of available DHCP failover servers defined and managed in the TCPWave IPAM. A failover DHCP server not only acts as a backup to the primary DHCP server but also shares the DHCP load.

Example Http Request
GET https://example.com:7443/tims/rest/dhcpserver/failover-list?id=317
Example Http Response
Content-Type : application/json
Content-Length : 2"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/failover-list?id=317"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

id
required

Server ID

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

< Server Information > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.7. Failover Server Configuration

GET /dhcpserver/failover-server-configuration/{server_address}
Description

Provides Failover DHCP server configuration of given Server address in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/dhcpserver/failover-server-configuration/163.35.10.57
Example Http Response
Content-Type : application/json
Content-Length : 217"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/failover-server-configuration/163.35.10.57"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Path

server_address
required

Required Server’s IP Address

string

Responses
HTTP Code Description Schema

200

successful operation

DHCP Failover

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.8. Generate Server Configuration for sync

GET /dhcpserver/generateConfig
Description

Generates Adhoc IPv4 DHCP Configuration and syncs the server with the latest configuration. Configuration generation is subjected to a sanity check process that validates the syntax of the DHCP Configuration to ensure that erroneous configuration is not sent to the server.

Example Http Request
https://example.com:7443/tims/rest/dhcpserver/generateConfig?address=1.0.0.5&organization_name=Internal  
Example Http Response
Content-Type : application/json
Content-Length : 94
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/generateConfig?address=1.0.0.5&organization_name=Internal  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

Required Server’s IP address

string

Query

organization_name
required

Required Organization Name

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.24.9. DHCP Server Heartbeat

GET /dhcpserver/heartbeat
Description

Provides Heartbeat status of any active IPv4 DHCP server in TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/dhcpserver/heartbeat?server_ip=10.1.10.184&server_type=dhcpServer
Example Http Response
Content-Type : text/plain
Content-Length : 7"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/heartbeat?server_ip=10.1.10.184&server_type=dhcpServer"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

server_ip
required

Required Server’s IP address

string

Query

server_type
required

Required Server’s type

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.24.10. DHCP Server List

GET /dhcpserver/list
Description

Obtains a list of all the IPv4 DHCP Servers configured in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/dhcpserver/list  
Example Http Response
Content-Type : application/json
Content-Length : 1679
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/list  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< Server Information > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.11. Primary DHCP Server List

GET /dhcpserver/primary-servers-list
Description

Obtains a list of available primary DHCP servers defined and managed by the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/dhcpserver/primary-servers-list?inEdit=0&org_name=Internal
Example Http Response
Content-Type : application/json
Content-Length : 8115"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/primary-servers-list?inEdit=0&org_name=Internal"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

inEdit
required

If Editable

integer(int32)

Query

org_name
required

Required Organization Name

string

Responses
HTTP Code Description Schema

200

successful operation

< Server Information > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.12. DHCP Server References

GET /dhcpserver/references
Description

Obtains a list of IPv4 DHCP Server references in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

count
required

Total Count

string

Query

id
required

Reference ID

string

Query

page
optional

Total Pages

integer(int32)

Query

rows
optional

Rows per page

integer(int32)

Query

tables
required

Reference Table

string

Responses
HTTP Code Description Schema

200

successful operation

Reference Results

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.13. Diagnostic Test for DHCP Server

GET /dhcpserver/runDiagnosticTest
Description

Provides alive server’s status by Diagnostic test for DHCP Server in TCPWave IPAM

Example Http Request
GET https://example.com:7443/tims/rest/dhcpserver/runDiagnosticTest?server_ip=10.1.10.184&server_type=dhcpServer
Example Http Response
Content-Type : application/json
Content-Length : 462"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/runDiagnosticTest?server_ip=10.1.10.184&server_type=dhcpServer"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< DNS/DHCP Diagnostic Test > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.14. Server Configuration

GET /dhcpserver/server-configuration/{server_address}
Description

Provides DHCP server configuration of given Server address in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/dhcpserver/server-configuration/10.1.10.184
Example Http Response
Content-Type : application/json
Content-Length : 2798"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/server-configuration/10.1.10.184"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Path

server_address
required

Required Server’s IP Address

string

Responses
HTTP Code Description Schema

200

successful operation

DHCP Server

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.15. Server Subnet References

GET /dhcpserver/server-subnet-references
Description

Obtains a list of subnet references that are associated with an IPv4 DHCP Server in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

IP address of the selected Server

string

Responses
HTTP Code Description Schema

200

successful operation

< Subnet Information > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.16. DHCP Server IP Count

GET /dhcpserver/serverIPCount
Description

Provides a count of total number of Dynamic DHCP IP Addresses that are managed by each IPv4 DHCP Server in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< string > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.17. Execute Command on DHCP Server

GET /dhcpserver/subsys
Description

Executing a Command for DHCP Server in TCPWave IPAM.Provides execution status of a given command number.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

argc
required

argc

integer(int32)

Query

level
required

Level

integer(int32)

Query

server_ip
required

Required Server’s IP address

string

Query

server_name
required

Required Server’s Name

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.24.18. Version Number

GET /dhcpserver/versions
Description

Provides a list of versions of various processes running on a given IPv4 DHCP Server such as DHCP, NTP, SNMP, T-Secure Message Tunnel etc.

Example Http Request
GET https://example.com:7443/tims/rest/dhcpserver/versions?address=163.35.10.57
Example Http Response
Content-Type : application/json
Content-Length : 402"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/versions?address=163.35.10.57"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

Required Server’s IP Address

string

Responses
HTTP Code Description Schema

200

successful operation

RemoteVersions

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.24.19. View Configuration

GET /dhcpserver/viewconfig
Description

Provides a view of the configuration of an IPv4 DHCP Server defined and managed by TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/dhcpserver/viewconfig?address=10.1.10.180  
Example Http Response
Content-Type : application/json
Content-Length : 60
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dhcpserver/viewconfig?address=10.1.10.180  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

IP address of the selected Server

string

Query

organization_name
required

Organization Name

string

Responses
HTTP Code Description Schema

200

successful operation

string

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.25. DNS Server Service

Description

This service provides API's to get list of DNS Servers present in the TCPWave IPAM, add DNS Servers, update DNS Servers, delete DNS Servers, download configuration for DNS Servers, dig a DNS Server, search for a DNS Server in the TCPWave IPAM.

4.25.1. DNS Server Add

POST /dnsserver/add
Description

Creates a new Authoritative or a cache only DNS server that can be used to service the DNS requests. This remote server is configured, maintained and managed by the product. What additional information on how to create a DNS server, please consult the product documentation.

Example Http Request
https://example.com:7443/tims/rest/dnsserver/add  -POST  {"server_type":"BIND AUTH","internal_cache_server":"1","dmzVisible":0,"autoDNSDR":"no","stealthServer":"0","v4_ipaddress":"1.1.0.5","name":"test-dns","domain_name":"10free.jpnbhgj","description":"test-dns-server","dns_server_template_id":"47","dns_options_template_id":"40998","firewall_template_id":28,"firewall_template_name":"DNS DDOS Prevention","monitoringService":"yes","created_by":"1978","snmpConfig":"{"trapSink1":"1.1.1.23","trapSink2":"1.1.1.24","communityString":"abc123","systemLocation":"Hyderabad","systemContact":"89399798","systemName":"test-dns.10free.jpnbhgj","processes":"ntpd-0/dns-1/crond-0/sshd-0/monit-0/rsyslog-0/dhcpd-0"}","timeZone":"GMT (GMT)","syslogConfig":"[{"action":"/var/log/messages","active":"yes","selector":"*.info;mail.none;authpriv.none;cron.none"},{"action":"/var/log/secure","active":"yes","selector":"authpriv.*"},{"action":"-/var/log/maillog","active":"yes","selector":"mail.*"},{"action":"/var/log/cron","active":"yes","selector":"cron.*"},{"action":":omusrmsg:*","active":"yes","selector":"*.emerg"},{"action":"/var/log/spooler","active":"yes","selector":"uucp,news.crit"},{"action":"/var/log/boot.log","active":"yes","selector":"local7.*"}]","ntpConfig":"1.1.1.12","viewList":[]}
Example Http Response
Content-Type : application/json
Content-Length : 63
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dnsserver/add  -d  '{"server_type":"BIND AUTH","internal_cache_server":"1","dmzVisible":0,"autoDNSDR":"no","stealthServer":"0","v4_ipaddress":"1.1.0.5","name":"test-dns","domain_name":"10free.jpnbhgj","description":"test-dns-server","dns_server_template_id":"47","dns_options_template_id":"40998","firewall_template_id":28,"firewall_template_name":"DNS DDOS Prevention","monitoringService":"yes","created_by":"1978","snmpConfig":"{"trapSink1":"1.1.1.23","trapSink2":"1.1.1.24","communityString":"abc123","systemLocation":"Hyderabad","systemContact":"89399798","systemName":"test-dns.10free.jpnbhgj","processes":"ntpd-0/dns-1/crond-0/sshd-0/monit-0/rsyslog-0/dhcpd-0"}","timeZone":"GMT (GMT)","syslogConfig":"[{"action":"/var/log/messages","active":"yes","selector":"*.info;mail.none;authpriv.none;cron.none"},{"action":"/var/log/secure","active":"yes","selector":"authpriv.*"},{"action":"-/var/log/maillog","active":"yes","selector":"mail.*"},{"action":"/var/log/cron","active":"yes","selector":"cron.*"},{"action":":omusrmsg:*","active":"yes","selector":"*.emerg"},{"action":"/var/log/spooler","active":"yes","selector":"uucp,news.crit"},{"action":"/var/log/boot.log","active":"yes","selector":"local7.*"}]","ntpConfig":"1.1.1.12","viewList":[]}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Server Information

Responses
HTTP Code Description Schema

500

TIMS-1335: DNS Internal Cache Server cannot be created as there is no root zone defined in this organization, TIMS-3079: Both DNS Options Template name and id cannot be null, TIMS-3080: DNS Options Template does not exist, TIMS-10102: Both view id and view name cannot be null, TIMS-10103: DNS View does not exist for name.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.25.2. Check if DNS Server is associated

GET /dnsserver/check_if_server_is_associated
Description

Checks if a DNS server is associated with any Proxy Root Zone or not in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

new_server_type
optional

New server type

string

Query

old_server_type
required

Old server type

string

Query

org_name
required

Organization Name

string

Query

server_ip
required

Server IP Address

string

Responses
HTTP Code Description Schema

500

TIMS-1020: Both Organization name and id cannot be null, TIMS-1352: Organization does not exist, TIMS-3020: Both server type and id cannot be null, TIMS-3088: Server IP address is null, TIMS-8085: Cannot change server type of BIND AUTH as it is used by one or more zones as Master, TIMS-8086: Cannot change server type of NSD to <New Server Type> as it is used by one or more zones as Slave, TIMS-8121: Server Type cannot be modified as it is used by Proxy Root Zone.

No Content

Consumes
  • text/plain

Produces
  • text/plain

4.25.3. DNS Server Delete

POST /dnsserver/delete
Description

Deletes an existing Authoritative or a cache only DNS server that is used to service the DNS requests. A DNS server cannot be deleted when it is actively servicing any forward zone or a reverse zone. For additional information on how to create a DNS server, please consult the product documentation.

Example Http Request
https://example.com:7443/tims/rest/dnsserver/delete?id=&address=102.0.0.36  -POST
Example Http Response
Content-Type : application/json
Content-Length : 60
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dnsserver/delete?id=&address=102.0.0.36  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
optional

Server IP Address

string

Query

id
required

Server Id

integer(int32)

Responses
HTTP Code Description Schema

500

TIMS-3050: Both server id and address cannot be null, TIMS-3052: Server is not deleted as other zone(s) are using it. Please remove the referencing zone(s) and retry, TIMS-3053: Server is not deleted as other zone template(s) are using it. Please remove the referencing zone template(s) and retry, TIMS-3055: Server is not deleted as other network(s) are using it. Please remove the referencing network(s) and retry, TIMS-3092: Server does not exist.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.25.4. DNS Server Delete Multiple

POST /dnsserver/deleteAll
Description

Deletes multiple DNS servers defined in the TCPWave IPAM. A DNS server cannot be deleted when it is actively servicing any forward zone or a reverse zone.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

< integer(int32) > array

Responses
HTTP Code Description Schema

500

TIMS-3050: Both server id and address cannot be null, TIMS-3052: Server is not deleted as other zone(s) are using it. Please remove the referencing zone(s) and retry, TIMS-3053: Server is not deleted as other zone template(s) are using it. Please remove the referencing zone template(s) and retry, TIMS-3055: Server is not deleted as other network(s) are using it. Please remove the referencing network(s) and retry, TIMS-3092: Server does not exist.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.25.5. Server Dig

GET /dnsserver/digserver
Description

Performs a basic name resolution for a given resource record using the target DNS server on which the check is to be executed in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/dnsserver/digserver?record_fqdn=aus.nsroot.net&record_type=A&server_ip=10.1.10.185&server_name=nusalx-sl0983-185&server_type=dnsServer
Example Http Response
Content-Type : text/plain
Content-Length : 242"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/digserver?record_fqdn=aus.nsroot.net&record_type=A&server_ip=10.1.10.185&server_name=nusalx-sl0983-185&server_type=dnsServer"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

record_fqdn
required

Record’s Fully Qualified Domain Name

string

Query

record_type
required

Record Type

string

Query

server_ip
required

Server IP Address

string

Query

server_name
required

Server Name

string

Query

server_type
required

Server Type

string

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-1369: Request timed out from DNS Server.

No Content

Consumes
  • text/plain

Produces
  • text/plain

4.25.6. DNS Server Edit

POST /dnsserver/edit
Description

Edits an existing Authoritative or a cache only DNS server that is used to service the DNS requests. This remote server is configured, maintained and managed by the product. For additional information on how to create a DNS server, please consult the product documentation.

Example Http Request
https://example.com:7443/tims/rest/dnsserver/edit  -POST  {"v4_ipaddress":"192.168.2.2","server_type":"BIND AUTH","dns_server_template_id":1,"dns_server_template_name":"dns1","dns_options_template_id":41308,"dns_options_template_name":"BIND AUTH Default Template","dmzVisible":0,"rootPassword":"Zxcv1234!"}
Example Http Response
Content-Type : application/json
Content-Length : 32
Status code :200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dnsserver/edit  -d  '{"v4_ipaddress":"192.168.2.2","server_type":"BIND AUTH","dns_server_template_id":1,"dns_server_template_name":"dns1","dns_options_template_id":41308,"dns_options_template_name":"BIND AUTH Default Template","dmzVisible":0,"rootPassword":"Zxcv1234!"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Server Information

Responses
HTTP Code Description Schema

500

TIMS-3030: Both object id and ip address cannot be null, TIMS-3031: Object is not deleted as it is associated with a zone, TIMS-3038: Server Type is not valid:<Server Type Code>, TIMS-3033: A server already exists with the specified address, TIMS-3034: Both DNS Server Template name and id cannot be null, TIMS-3035: Specified DNS Server Template not found, TIMS-3036: Both DNS Options Template name and id cannot be null, TIMS-3037: Specified DNS Options Template not found, TIMS-3039: Cannot create a server using a DHCP object, TIMS-10102: Both view id and view name cannot be null, TIMS-10103: DNS View does not exist for name, TIMS-5033: Server Template does not exist, TIMS-3050: Both server id and address cannot be null, TIMS-3091: Server does not exists, TIMS-1336: DNS Server cannot be changed to Internal DNS Cache server as there is no root zone defined in this organization, TIMS-5009: Option Template does not exist, TIMS-3079: Both DNS Options Template name and id cannot be null, TIMS-3009: Object does not exist.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.25.7. Export Logs To CSV

POST /dnsserver/exportlogstocsv
Description

Exports the DNS server logs to a csv file in the TCPWAVE IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

argc
required

argc

integer(int32)

Query

ip
required

Server IP Address

string

Query

log_type
required

Log Type

string

Query

scode
required

Server Code

string

Query

serverType
required

DNS Server Type

string

Query

type
required

Server Type(DNS/DHCP)

string

Responses
HTTP Code Description Schema

200

successful operation

string

500

HomeService: Incorrect command {the given command}, Remote did not respond for this command

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.25.8. Forwarders Add

POST /dnsserver/forwarders/add
Description

Adds a new DNS forwarder that is used to resolve DNS zones that are not managed by the TCPWave IPAM. For additional information about the cache only DNS servers and the configuration of the forwarders, please refer to the product documentation.

Example Http Request
https://example.com:7443/tims/rest/dnsserver/forwarders/add  -POST {"zoneName":"tcpwave.com","forward":"only","forwardersIPv4":"192.168.2.4","description":"Default Forward zone","serverV4Addr":"192.168.2.2","serverType":"BIND CACHE"}
Example Http Response
Content-Type : application/json
Content-Length : 52
Status code :200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dnsserver/forwarders/add  -d '{"zoneName":"tcpwave.com","forward":"only","forwardersIPv4":"192.168.2.4","description":"Default Forward zone","serverV4Addr":"192.168.2.2","serverType":"BIND CACHE"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

< Server Forwarder > array

Responses
HTTP Code Description Schema

500

TIMS-1427: Forward only zone: <Zone Name> already exists in the DNS server, TIMS-1429: Cannot create a forward only zone: <Zone Name> as it is already managed by IPAM.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.25.9. Forwarders Delete

POST /dnsserver/forwarders/delete
Description

Deletes a DNS forwarder that is used to resolve DNS zones that are not managed by the TCPWave IPAM. . For additional information about the cache only DNS servers and the configuration of the forwarders, please refer to the product documentation.

Example Http Request
https://example.com:7443/tims/rest/dnsserver/forwarders/delete  -POST {"zoneName":"tcpwave.com","serverV4Addr":"10.1.10.29","serverType":"BIND CACHE"}
Example Http Response
Content-Type : application/json
Content-Length : 60
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dnsserver/forwarders/delete  -d '{"zoneName":"tcpwave.com","serverV4Addr":"10.1.10.29","serverType":"BIND CACHE"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

< Server Forwarder > array

Responses
HTTP Code Description Schema

500

TIMS-1425: Both server id and server IP address cannot be null, TIMS-1426:DNS Internal Cache Server does not exist.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.25.10. Forwarders List

GET /dnsserver/forwarders/list
Description

Obtains a list of forwarding DNS server addresses defined in the cache only DNS server properties. For additional information about the cache only DNS servers and the configuration of the forwarders, please refer to the product documentation.

Example Http Request
https://example.com:7443/tims/rest/dnsserver/forwarders/list?address=10.1.10.184  
Example Http Response
Content-Type : application/json
Content-Length : 2
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/forwarders/list?address=10.1.10.184  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

Server IP Address

string

Query

id
required

Server Id

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

< Server Forwarder > array

500

TIMS-1425: Both server id and server IP address cannot be null, TIMS-1426: DNS Internal Cache Server does not exist.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.25.11. Forwarders Update

POST /dnsserver/forwarders/update
Description

Updates the DNS forwarder that is used to resolve DNS zones that are not managed by the TCPWave IPAM. For additional information about the cache only DNS servers and the configuration of the forwarders, please refer to the product documentation.

Example Http Request
https://example.com:7443/tims/rest/dnsserver/forwarders/update  -POST {"zoneName":"tcpwave.com","forward":"only","forwardersIPv4":"10.1.10.204;10.1.10.10","description":"Default Forward zone","serverV4Addr":"10.1.10.29","serverType":"BIND CACHE"}
Example Http Response
Content-Type : application/json
Content-Length : 52
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dnsserver/forwarders/update  -d '{"zoneName":"tcpwave.com","forward":"only","forwardersIPv4":"10.1.10.204;10.1.10.10","description":"Default Forward zone","serverV4Addr":"10.1.10.29","serverType":"BIND CACHE"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

< Server Forwarder > array

Responses
HTTP Code Description Schema

500

TIMS-1428: Forward only zone: {given forwarders} does not exist.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.25.12. Generate Configuration

GET /dnsserver/genconfig
Description

From the data repository a list of configuration files are generated and various data integrity checks are done. The files are securely transferred to the remote. Compression is used during the final transfer. On the remote, the compressed configureation files expanded and put into appropriate places and the service is refreshed or restarted depending on the global option defined for file synchronization.

Example Http Request
https://example.com:7443/tims/rest/dnsserver/genconfig?server_type_code=BIND+AUTH&address=1.0.0.10&organization_name=Internal  
Example Http Response
Content-Type : application/json
Content-Length : 199
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/genconfig?server_type_code=BIND+AUTH&address=1.0.0.10&organization_name=Internal  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

Server IP Address

string

Query

organization_name
required

Organization Name

string

Query

server_type_code
required

DNS Server Type

string

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-1349: DNS Configuration sync failed with error

No Content

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.25.13. DNS Server Details

GET /dnsserver/get
Description

Lists all the zones defined in the TCPWave IPAM. Functional Admin gets the list of all servers. Rest of the Admins get only the list of servers associated with the organization that they belong to.

Example Http Request
https://example.com:7443/tims/rest/dnsserver/get?serverIp=10.1.10.240  
Example Http Response
Content-Type : application/json
Content-Length : null
Status code :200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/get?serverIp=10.1.10.240  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

serverIp
required

Server IP Address

string

Query

serverTypeCode
optional

Server Type Code

string

Responses
HTTP Code Description Schema

200

successful operation

Server Information

500

TIMS-3050: Both server id and address cannot be null.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.25.14. Server Hearbeat Check

GET /dnsserver/heartbeat
Description

Check for the heartbeat of the serverPerforms a check if the remote DNS server is having a heartbeat communication with the management server.

Example Http Request
GET https://example.com:7443/tims/rest/dnsserver/heartbeat?server_ip=169.191.96.15&server_type=dnsServer
Example Http Response
Content-Type : text/plain
Content-Length : 4"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/heartbeat?server_ip=169.191.96.15&server_type=dnsServer"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

server_ip
required

Server IP Adress

string

Query

server_type
required

Server Type

string

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-3088: Server IP address is null, TIMS-8230: Server type is null.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.25.15. DNS Server List

GET /dnsserver/list
Description

Obtain a List of all the DNS Servers defined in the TCPWave IPAM. Functional Admin gets the list of all servers. Rest of the Admins get only the list of servers associated with the organization that they belong to.

Example Http Request
https://example.com:7443/tims/rest/dnsserver/list  
Example Http Response
Content-Type : application/json
Content-Length : 1700
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/list  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< Server Information > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.25.16. DNS Server List

GET /dnsserver/page
Description

Obtain a List of all the DNS Servers defined in the TCPWave IPAM. Functional Admin gets the list of all servers. Rest of the Admins get only the list of servers associated with the organization that they belong to.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

filterRules
required

Filter String

string

Query

order
required

Sorting Order(asc/desc)

string

Query

page
required

Page number

integer(int32)

Query

q
required

Search String

string

Query

rows
required

Rows per page

integer(int32)

Query

sort
required

Sorting String

string

Responses
HTTP Code Description Schema

200

successful operation

PagedListServer Information

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.25.17. Server Refrences In Zones

GET /dnsserver/references
Description

Obtains a list of DNS zones that have a references to the DNS server for which DNS Zone associations have been defined.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

count
optional

Count Flag

string

Query

id
required

Server Refrence Id

string

Query

page
optional

Page Number

integer(int32)

Query

rows
optional

Number of rows

integer(int32)

Query

tables
required

Tables

string

Responses
HTTP Code Description Schema

200

successful operation

Reference Results

500

TIMS-3050: Both server id and address cannot be null, TIMS-3092: Server does not exist: <given ip address>

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.25.18. Run Diagnostic Test

GET /dnsserver/runDiagnosticTest
Description

Performs remote diagnostics on a DNS Server. This action can be performed by a user with appropriate privileges and this action is audited.

Example Http Request
GET https://example.com:7443/tims/rest/dnsserver/runDiagnosticTest
Example Http Response
Content-Type : application/json
Content-Length : 2"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/runDiagnosticTest"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< DNS/DHCP Diagnostic Test > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.25.19. Server Search

GET /dnsserver/search
Description

Searches for the DNS Servers in the TCPWave IPAM. The search results will be displayed in the search window categorized based on where they occur in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/dnsserver/search?page=1&rows=20
Example Http Response
Content-Type : application/json
Content-Length : 21"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/search?page=1&rows=20"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

page
optional

Page Number

integer(int32)

Query

rows
optional

Number of rows

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListServer Information

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.25.20. Server Configuration

GET /dnsserver/server-configuration/{server_address}/{server_type}
Description

Lists the configuration type and configuration data for an existing server in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/dnsserver/server-configuration/169.191.96.15/BIND%20AUTH
Example Http Response
Content-Type : application/json
Content-Length : 1605"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/server-configuration/169.191.96.15/BIND%20AUTH"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Path

server_address
required

Server IP Address

string

Path

server_type
required

Server Type Code

string

Responses
HTTP Code Description Schema

200

successful operation

Server Information

500

TIMS-3038: Server Type is not valid:<Server Type Code>

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.25.21. Server Refrences in Zone Template

GET /dnsserver/server-references
Description

Obtains a list of all the zone templates for which a given DNS server has associations defined in the product. For additional information about the DNS zone templates, please refer to the product documentation.

Example Http Request
GET https://example.com:7443/tims/rest/dnsserver/server-references?address=169.191.96.15&id=307
Example Http Response
Content-Type : application/json
Content-Length : 0"	
Status code : 204 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/server-references?address=169.191.96.15&id=307"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

Server IP Address

string

Query

id
required

Server Id

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-3050: Both server id and address cannot be null.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.25.22. Server Command

GET /dnsserver/subsys
Description

Executes a remote DNS server process controlling command that is audited and can only be invoked by the management system.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

argc
required

argc

integer(int32)

Query

argv
required

argv

string

Query

level
required

Level Number

integer(int32)

Query

server_ip
required

Server IP Address

string

Query

server_name
required

Server Name

string

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-1369: Request timed out from DNS Server.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.25.23. Server Versions

GET /dnsserver/versions
Description

Retrieve the version numbers of the running services on the TCPWave Remotes defined in the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/dnsserver/versions?address=169.191.96.15
Example Http Response
Content-Type : application/json
Content-Length : 0"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/versions?address=169.191.96.15"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

Server IP Address

string

Responses
HTTP Code Description Schema

200

successful operation

RemoteVersions

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.25.24. View Configuration of DNS Server

GET /dnsserver/viewconfig
Description

Downloads the configuration file for the selected DNS server in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

address
required

Server IP Address

string

Query

server_type_code
required

DNS Server Type

string

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-1349: DNS Configuration sync failed with error

No Content

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

  • text/plain

4.25.25. DNS Server Zone List

GET /dnsserver/zonelist
Description

Obtains a list of DNS zones that are actively being serviced on a given DNS server. This list includes forward zones and reverse zones.

Example Http Request
GET https://example.com:7443/tims/rest/dnsserver/zonelist?id=307&name=nau2prk-qrs01-sl0984
Example Http Response
Content-Type : application/json
Content-Length : 2"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver/zonelist?id=307&name=nau2prk-qrs01-sl0984"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

id
required

Server Id

integer(int32)

Query

name
required

Server Name

string

Query

revZone
optional

If Reverse Zone

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

< ServerZone > array

500

TIMS-3090: Both server id and name cannot be null, TIMS-3092: Server does not exist.

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.26. DNS Server Template Service

Description

This service provides API's to get list of DNS Server Templates present in the TCPWave IPAM, add DNS Server Templates , update DNS Server Templates, delete DNS Server Templates, search for a DNS Server Template in the TCPWave IPAM.

4.26.1. DNS Server Template Add

POST /dnsserver_template/add
Description

Creates a new Server Template by checking if it overlaps with the existing Server Template defined in the TCPWave IPAM. Functional Admin can create a new Server Template for any organization. Rest of the admins can create a new Server Template only for the organizations that they are associated with.Refer to the Administrator reference documentation for additional information about the DNS Server Template.

Example Http Request
https://example.com:7443/tims/rest/dnsserver_template/add  -POST  {"name":"AUTH-Server-Template","server_type_code":"BIND AUTH","email_id":"john.smith@tcpwave.com","enable_remote_control":false,"enable_dnssec":true,"enable_dynamic_updates":true,"description":"AUTH Server Template","algos":[{"code":"HMAC-SHA1","bitSize":150},{"code":"HMAC-SHA256","bitSize":200}],"loggers":[{"category":{"category":"client"},"channels":[{"channel":"default_stderr"},{"channel":"default_debug"},{"channel":"default_syslog"}]}}
Example Http Response
Content-Type : application/json
Content-Length : null
Status code :200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dnsserver_template/add  -d  '{"name":"AUTH-Server-Template","server_type_code":"BIND AUTH","email_id":"john.smith@tcpwave.com","enable_remote_control":false,"enable_dnssec":true,"enable_dynamic_updates":true,"description":"AUTH Server Template","algos":[{"code":"HMAC-SHA1","bitSize":150},{"code":"HMAC-SHA256","bitSize":200}],"loggers":[{"category":{"category":"client"},"channels":[{"channel":"default_stderr"},{"channel":"default_debug"},{"channel":"default_syslog"}]}}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

DNS Server Template

Responses
HTTP Code Description Schema

500

TIMS-3026: A template with the specified name already exists, TIMS-3020: Both server type and id cannot be null, TIMS-5029: Template name is not specified, TIMS-3038: Server Type is not valid: <server type code>, TIMS-2003: ACLs are not valid, TIMS-2010: Algorithm is not valid: <Algorithm Code>, TIMS-3022: Bit size should be between <Min Algo code> and <Max Algo code> for algorithm <Algorithm code>, TIMS-3023: Logger is not valid.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.26.2. DNS Server Template Delete

POST /dnsserver_template/delete
Description

Deletes an existing Server Template in the TCPWave IPAM. Functional Admin can delete a Server Template for any organization. Rest of the admins can delete a Server Template only for the organizations that they are associated with.

Example Http Request
https://example.com:7443/tims/rest/dnsserver_template/delete?id=&name=DNS+Appliance+Template  -POST
Example Http Response
Content-Type : application/json
Content-Length : 57
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/dnsserver_template/delete?id=&name=DNS+Appliance+Template  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

id
required

integer(int32)

Query

name
required

Template Name

string

Query

updated_by
required

Updated By

integer(int32)

Responses
HTTP Code Description Schema

500

TIMS-5020: Template does not exist:<Template Name>, TIMS-5031: Both template name and id cannot be null, TIMS-5032: Template is not deleted as other server(s) is(are) using it. Please remove the referencing server(s) and retry.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.26.3. DNS Server Template Edit

POST /dnsserver_template/edit
Description

Updates an existing Server Template in the TCPWave IPAM. Functional Admin can update a Server Template for any organization. Rest of the admins can update a Server Template only for the organizations that they are associated with.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

DNS Server Template

Responses
HTTP Code Description Schema

500

TIMS-5020: Template does not exist:<Template Name>, TIMS-5031: Both template name and id cannot be null, TIMS-5028: Template does not exist, TIMS-3020: Both server type and id cannot be null, TIMS-3026: A template with the specified name already exists, TIMS-3038: Server Type is not valid: <Server Type Code>, TIMS-2003: ACLs are not valid, TIMS-2010: Algorithm is not valid: <Algorithm Code>, TIMS-3022: Bit size should be between <Min Algo code> and <Max Algo code> for algorithm <Algorithm code>, TIMS-3023: Logger is not valid.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.26.4. DNS Server Template Details

GET /dnsserver_template/get
Description

Lists all the Server Templates associated with an organization in the TCPWave IPAM. Functional Admin can list the Server Templates for any organization. Rest of the admins can list the Server Templates only for the organizations that they are associated with.

Example Http Request
https://example.com:7443/tims/rest/dnsserver_template/get?name=NSD  
Example Http Response
Content-Type : application/json
Content-Length : 597
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver_template/get?name=NSD  
Parameters
Type Name Description Schema

Query

id
required

Template Id

integer(int32)

Query

name
required

Template Name

string

Responses
HTTP Code Description Schema

200

successful operation

DNS Server Template

500

TIMS-5020: Template does not exist:<Template Name>, TIMS-5031: Both template name and id cannot be null.

No Content

Consumes
  • application/json

  • application/xml

  • text/plain

Produces
  • application/json

  • application/xml

4.26.5. DNS Server Template List

GET /dnsserver_template/list
Description

Lists all the server templates defined in the TCPWave IPAM. These are used to create a DNS server in the TCPWave IPAM.Functional Admin gets the list of all server templates. Rest of the Admins get only the list of server templates associated with the organization that they belong to.

Example Http Request
https://example.com:7443/tims/rest/dnsserver_template/list  
Example Http Response
Content-Type : application/json
Content-Length : 1249
Status code : 200 
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/dnsserver_template/list  
Parameters
Type Name Description Schema

Query

server_type_code
required

Server Type Code

string

Query

server_type_id
required

Server Type Id

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

< DNS Server Template > array

500

TIMS-3038: Server Type is not valid: <Server Type Code>

No Content

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.26.6. Server Template References

GET /dnsserver_template/references
Description

Obtains a list of DNS Servers that have a references to the DNS Server Templates for which DNS Servers associations have been defined.

Parameters
Type Name Description Schema

Query

count
optional

Count Flag

string

Query

id
required

Refrence Id

string

Query

page
optional

Page Number

integer(int32)

Query

rows
optional

Number of Rows

integer(int32)

Query

tables
required

Tables

string

Responses
HTTP Code Description Schema

200

successful operation

Reference Results

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.26.7. Server Template Search

GET /dnsserver_template/search
Description

Provides the list of searched Server Templates on search screen in the TCPWave IPAM. Functional Admin gets the list of searched Server Templates for any organization. Rest of the Admins gets only the list of searched Server Templates associated with the organization that they belong to.

Parameters
Type Name Description Schema

Query

page
optional

Page Number

integer(int32)

Query

rows
optional

Number of Rows

integer(int32)

Responses
HTTP Code Description Schema

200

successful operation

PagedListDNS Server Template

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.27. DNS Tools Service

Description

This service provides API's to perform a basic name resolution for a given resource record upon the targeted DNS Server present in the TCPWave IPAM, to snchronize the DNS Server data for a given Server by fetching all the configuration specified from the TCPWave data repository.

4.27.1. Resource Record Converge

POST /dnstools/converge
Description

Resource record look up in remote DNS Server.Performs a basic name resolution for a given resource record using the target DNS server on which the check is to be executed in the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

DNS Server Tool

Responses
HTTP Code Description Schema

200

successful operation

< DNS Server Tool > array

500

TIMS-1020: Both Organization name and id cannot be null, TIMS-1352: Organization does not exist:<Oragnization Name>, TIMS-1422: TIMS-1422: Zone does not exist:<Zone Name>

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.27.2. Resource Record Sync

POST /dnstools/sync
Description

Synchronize the Resource Record of IPAM with DNS Server.Synchronizes the DNS Server data for a given Server by fetching all the configuration specified from the TCPWave data repository. The DNS Server files are constructed as per the TCPWave Product Engineering’s specifications with various integrity checks embedded into them. The files are then compressed and transmitted to the remote using an encrypted T-Message secure tunnel. The compressed files are uncompressed on the remote and the DNS process on the remote is signaled to read the updated contents. The administrator performing this action is required to have a sync permission. This action is audited.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Query

domainname
required

Domain Name

string

Query

recordname
required

Record Name

string

Query

recordtype
required

Record Type

string

Query

serverip
required

Server IP Address

string

Query

servertype
required

Server Type Code

string

Responses
HTTP Code Description Schema

200

successful operation

string

500

TIMS-3050: Both server id and address cannot be null, TIMS-3088: Server IP address is null, TIMS-8230: Server type is null, TIMS-3050: Both server id and address cannot be null.

No Content

Consumes
  • text/plain

Produces
  • text/plain

4.28. Database Service

Description

This service class provides services related to Database such as dump, back-up, snapshot, restore, delete snapshot etc in TCPWave IPAM. TCPWave IPAM supports storing database backup on AWS-S3 and restoring database from AWS-S3.

4.28.1. Apply Binlog for Database

POST /db/apply-binlog
Description

Loads the database incremental changes into a recovery database in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/db/apply-binlog  -POST  {"dumpDir":"Dump_1408948935","applybinlog":false}
Example Http Response
Content-Type : application/json
Content-Length : 0
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/db/apply-binlog  -d  '{"dumpDir":"Dump_1408948935","applybinlog":false}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Apply Binlog Request

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.28.2. Apply Snapshot on Database

POST /db/apply-snapshot
Description

Loads a database snapshot into a recovery database in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/db/apply-snapshot  -POST  {"snapshotDir":"/tmp/dumps/Dump_1408948935"}
Example Http Response
Content-Type : application/json
Content-Length : 60
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/db/apply-snapshot  -d  '{"snapshotDir":"/tmp/dumps/Dump_1408948935"}'
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Apply DB Snapshot Request

Responses
HTTP Code Description Schema

500

TIMS-9555: Error occurred while making tar.gz file of database snapshots.

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.28.3. Backup Binlog for Database

POST /db/backup-binlog
Description

Performs a backup of the incremental changes in the TCPWave IPAM.

Example Http Request
https://example.com:7443/tims/rest/db/backup-binlog  -POST
Example Http Response
Content-Type : application/json
Content-Length : 89
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/db/backup-binlog  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Produces
  • application/json

  • application/xml

4.28.4. Uploads Backup Database to AWS S3

POST /db/backupdbtoaws
Description

Takes Backup of IPAM Database and Uploads it to AWS S3.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.28.5. Delete Database Snapshot

POST /db/deletedbsnapshot
Description

Deletes the database snapshot in the TCPWave IPAM. This action is audited.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

Apply Binlog Request

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.28.6. Downloads AWS S3 File

POST /db/downloadawss3file
Description

Downloads a specified backup file from AWS S3 bucket in the TCPWave IPAM. Bucket name is obtained from the global option of the TCPWave IPAM.

Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Body

body
optional

AwsS3 File

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

Produces
  • application/json

  • application/xml

4.28.7. Dump Database

POST /db/dumpdb
Description

Captures a backup database snapshot of the existing data in the TCPWave IPAM .

Example Http Request
https://example.com:7443/tims/rest/db/dumpdb  -POST
Example Http Response
Content-Type : application/json
Content-Length : 60
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" -H "Content-Type : application/json" https://example.com:7443/tims/rest/db/dumpdb  
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

Dump DB Response

500

TIMS-9554: Failed to dump the database.

No Content

Produces
  • application/json

  • application/xml

4.28.8. Lists s3 backup files

GET /db/lists3files
Description

Obtains a list of all uploaded backup files from AWS S3 bucket. Bucket name is obtained from the global option of the TCPWave IPAM.

Example Http Request
GET https://example.com:7443/tims/rest/db/lists3files
Example Http Response
Content-Type : application/json
Content-Length : 2"	
Status code : 200 OK
Example Curl Request
$ curl -X -H "TIMS-Session-Token: 6f5ab0a2-f250-4fa5-b2d8-ca9e01e91913" https://example.com:7443/tims/rest/db/lists3files"
Parameters
Type Name Description Schema

Header

TIMS-Session-Token
optional

Session token for authorization

string

Responses
HTTP Code Description Schema

200

successful operation

< AwsS3 File > array

Consumes
  • text/plain

Produces
  • application/json

  • application/xml

4.28.9. Delete Backup Files

POST /db/multideletes3files
Descr