@itentialopensource/adapter-tcpwave
Version:
This adapter integrates with system described as: tcpwaveRestapiStore.
1,712 lines • 2.13 MB
JSON
{
"swagger": "2.0",
"info": {
"description": "This API Calls allows 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 this REST call is audited by the TCPWave IPAM. Customers are advised to execute this REST API call in a non production environment before attempting to execute it in a production environment.",
"version": "1.0.0",
"title": "TCPWave RestAPI Store"
},
"basePath": "/tims/rest",
"tags": [
{
"name": "Acl Service"
},
{
"name": "Active Directory Service"
},
{
"name": "Admin Group Service"
},
{
"name": "Alarm Subscription Service"
},
{
"name": "Algorithm Service"
},
{
"name": "Appliance Group Service"
},
{
"name": "Asset Service"
},
{
"name": "Audit data Backup Files Service"
},
{
"name": "Audit Report Service"
},
{
"name": "Audit Logs and License Information"
},
{
"name": "Authentication Configuration Service"
},
{
"name": "Authentication Token management"
},
{
"name": "Authentication Type"
},
{
"name": "Authorization Information"
},
{
"name": "Bookmark Service"
},
{
"name": "Central Logging Service"
},
{
"name": "Certificate Management Service"
},
{
"name": "Chart Service"
},
{
"name": "Checkouts Service Details"
},
{
"name": "Class Code Logo Service"
},
{
"name": "Class Code Service"
},
{
"name": "Cloud Instance Service"
},
{
"name": "Cloud DNS Provider Service"
},
{
"name": "Contact Service"
},
{
"name": "Contingency Service Details"
},
{
"name": "Database Service"
},
{
"name": "DHCP Active Lease Service"
},
{
"name": "DHCP Class Service"
},
{
"name": "DHCP option space"
},
{
"name": "DHCP Appliance Service"
},
{
"name": "DNS Analytics Service"
},
{
"name": "DNS Forwarders Service"
},
{
"name": "DNS Appliance Service"
},
{
"name": "DNS Appliance Template Service"
},
{
"name": "DNS Tools Service"
},
{
"name": "DNSViz Service"
},
{
"name": "Discovery Service"
},
{
"name": "Discovery Template Service"
},
{
"name": "Domain Service"
},
{
"name": "Dropdown Service"
},
{
"name": "Export Compliance Management Service"
},
{
"name": "Export Service"
},
{
"name": "File Distribution Management Service"
},
{
"name": "File Upload Service"
},
{
"name": "Firewall Service"
},
{
"name": "Global Options Service"
},
{
"name": "Heartbeat Message Service"
},
{
"name": "Hierarchy Service"
},
{
"name": "History Tab Service"
},
{
"name": "Home Service"
},
{
"name": "Host Naming Policy"
},
{
"name": "IPAM Appliance Service"
},
{
"name": "IPAM Template Service"
},
{
"name": "IPAM Version Service"
},
{
"name": "IPV6 DHCP Appliance Service"
},
{
"name": "IPV6 Scope Service"
},
{
"name": "IPV6 Template Service"
},
{
"name": "IPV6 Network Service"
},
{
"name": "IPV6 Object Service"
},
{
"name": "IPV6 Subnet Group Service"
},
{
"name": "IPV6 Subnet Service"
},
{
"name": "Import Cloud Service"
},
{
"name": "Import Service"
},
{
"name": "Internet Root Hints Service"
},
{
"name": "Location Service"
},
{
"name": "Log Category Service"
},
{
"name": "Log Channel Service"
},
{
"name": "Manage Appliance Services"
},
{
"name": "Mirrored Zone Service"
},
{
"name": "Monitor Service"
},
{
"name": "Message Certificate Management Service"
},
{
"name": "Network Service"
},
{
"name": "Firmware Patch Service"
},
{
"name": "Object Service"
},
{
"name": "Organization ImportExport Service"
},
{
"name": "Organization Service"
},
{
"name": "Params Service"
},
{
"name": "Quick Move Service"
},
{
"name": "RPZ Service"
},
{
"name": "Reverse Zone Service"
},
{
"name": "Role Service"
},
{
"name": "Root Access Management Service"
},
{
"name": "Scheduler related calls Service"
},
{
"name": "Scheduled Job Executor Status Service"
},
{
"name": "Scheduled Job Service"
},
{
"name": "Schedule Handler Service"
},
{
"name": "Scheduled Audit Report Service"
},
{
"name": "Scope Service"
},
{
"name": "Search Service"
},
{
"name": "Server License Service"
},
{
"name": "Server Service"
},
{
"name": "Appliance Sync Status Service"
},
{
"name": "Subnet Group Service"
},
{
"name": "Subnet Service"
},
{
"name": "Subnet Template Service"
},
{
"name": "Switch Discovery Details Service"
},
{
"name": "Template Service"
},
{
"name": "Time Zone Service"
},
{
"name": "UndoData Service"
},
{
"name": "User Certificate Service"
},
{
"name": "User Service"
},
{
"name": "IPv6 Audit Report Service"
},
{
"name": "View Service"
},
{
"name": "Widget Service"
},
{
"name": "Microsoft DHCP Appliance Service"
},
{
"name": "Microsoft DNS Appliance Service"
},
{
"name": "Workflow Handler Service"
},
{
"name": "Zone Service"
},
{
"name": "Cloud Network Service"
},
{
"name": "VMware Discovery Details Service"
},
{
"name": "IPv6 Subnet Template Service"
}
],
"schemes": [
"https"
],
"paths": {
"/acls/create": {
"post": {
"tags": [
"Acl Service"
],
"summary": "ACL 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. ACL cannot be created when the object(s) or subnet(s) or network(s) used to create ACL are not managed in the IPAM.\n Below example shows sample request JSON: \n {\"aclElementList\":\\[{\"exclude\":0,\"sequence\":1,\"value\":\"10.2.3.5\"}\\],\"name\":\"test-client\",\"description\":\"Testing REST API\"}",
"operationId": "aclCreate",
"consumes": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "ACL details",
"required": true,
"schema": {
"$ref": "#/definitions/Access Control List(ACL)"
}
}
],
"responses": {
"500": {
"description": "TIMS-2002: ACL already exists, TIMS-2007: ACL name is not valid, TIMS-14049: Cannot create the ACL as managed object(s) or subnet(s) or network(s) with IP addresses <IP Address> are not available in IPAM, TIMS-2007: The ACL name is not valid : <ACL name>"
}
}
}
},
"/acls/update": {
"post": {
"tags": [
"Acl Service"
],
"summary": "ACL Edit",
"description": "Updates an existing Access Control List(ACL) in the TCPWave IPAM. ACL cannot be updated when the object(s) or subnet(s) or network(s) used\n to update ACL are not managed in the IPAM.\n Below example shows sample request JSON: \n {\"name\":\"test-client\",\"newName\":\"new-test-client\",\"description\":\"ACL added to the TCPWave IPAM by Professional Services\",\"aclElementList\":[{\"value\":\"10.24.6.8\",\"sequence\":\"1\",\"exclude\":\"0\"},{\"value\":\"10.24.6.9\",\"sequence\":\"2\",\"exclude\":\"0\"},{\"value\":\"10.24.11.9\",\"sequence\":\"3\",\"exclude\":\"0\"},{\"value\":\"10.24.15.8\",\"sequence\":\"4\",\"exclude\":\"0\"},{\"value\":\"10.1.1.1\",\"sequence\":\"5\",\"exclude\":\"0\"},{\"refAclName\":\"localnets\",\"sequence\":\"6\",\"exclude\":\"0\"}]}",
"operationId": "aclUpdate",
"consumes": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "ACL details",
"required": true,
"schema": {
"$ref": "#/definitions/Access Control List(ACL)"
}
}
],
"responses": {
"500": {
"description": "TIMS-2001: ACL(s) not found,\n TIMS-2002: ACL already exists,\n TIMS-2006: ACL is not valid,\n TIMS-14050: Cannot update the ACL as managed object(s) or subnet(s) or network(s) with IP addresses {0} are not available in IPAM\n TIMS-1737: ACL object cannot be null."
}
}
}
},
"/acls/list": {
"get": {
"tags": [
"Acl Service"
],
"summary": "ACL List",
"description": "Obtains the list of Access Control List(ACL) defined and managed by the TCPWave IPAM which are used to control the behavior of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc.",
"operationId": "aclList",
"produces": [
"application/json",
"application/xml"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Access Control List(ACL)"
}
}
},
"500": {
"description": "TIMS-2001: ACL(s) not found"
}
}
}
},
"/acls/get": {
"get": {
"tags": [
"Acl Service"
],
"summary": "ACL Details",
"description": "Provides the list of Access Control List(ACL) in the TCPWave IPAM which are used to control the behavior of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc.",
"operationId": "aclGet",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "ACL Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Access Control List(ACL)"
}
},
"500": {
"description": "TIMS-2001: ACL(s) not found"
}
}
}
},
"/acls/getreferences": {
"get": {
"tags": [
"Acl Service"
],
"summary": "ACL References",
"description": "Provides the list of Option Templates, Zone Templates and AD enabled Zones in the TCPWave IPAM which use specific Access Control List(ACL)",
"operationId": "aclGetReferences",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "ACL Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"500": {
"description": "TIMS-12004: ACL Reference(s) not found."
}
}
}
},
"/acls/multidelete": {
"post": {
"tags": [
"Acl Service"
],
"summary": "ACL Delete Multiple",
"description": "Deletes multiple existing Access Control Lists(ACLs) from the TCPWave IPAM data repository. This action is audited. Below example shows sample request JSON: [\"test-client\"]",
"operationId": "aclMultiDelete",
"consumes": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "List of ACL names",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"500": {
"description": "TIMS-2001: ACL(s) not found,\n TIMS-1307: Root zone(s) does(do) not exist."
}
}
}
},
"/acls/search": {
"get": {
"tags": [
"Acl Service"
],
"summary": "Search ACL",
"description": "Provides the list of searched Access Control List(ACL) on search screen in the TCPWave IPAM.",
"operationId": "aclPage",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "rows",
"in": "query",
"description": "Number of Rows",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/PagedListAccess Control List(ACL)"
}
}
}
}
},
"/activedirectory/useradd": {
"post": {
"tags": [
"Active Directory Service"
],
"summary": "Active Directory User Add",
"description": "Creates a mapping of existing Active Directory Domain Services (AD DS) to User Principal Name (UPN) into the TCPWave IPAM. A UPN is the name of a system user in an e-mail address format.Example: username@user.associated.internet.domain.\nBelow example shows sample request JSON:\n{\"dc_ip\":\"10.1.2.3\",\"dnsDomainName\":\"apac.nsroot.net\",\"dnsIp\":\"10.1.2.4\",\"dnsServerName\":\"server1\",\"encryption_type\":\"RC4-HMAC-NT\",\"file_data\":\"File Data\",\"file_name\":\"filename\",\"principal_name\":\"server1@domain.com\",\"principal_type\":\"KRB5_NT_PRINCIPAL\",\"realm\":\"TCPWAVE.COM\",\"service_type\":\"ServerType\"}",
"operationId": "adUserAdd",
"consumes": [
"application/json",
"application/xml",
"multipart/form-data"
],
"parameters": [
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/Active Directory"
}
}
],
"responses": {
"500": {
"description": "TIMS-7003: You are not authorized to perform this operation, TIMS-1312: Duplicate entry."
}
}
}
},
"/activedirectory/userlist": {
"get": {
"tags": [
"Active Directory Service"
],
"summary": "Active Directory User list",
"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. Example: username@user.associated.internet.domain.",
"operationId": "adUserList",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Active Directory"
}
}
}
}
}
},
"/activedirectory/delete": {
"post": {
"tags": [
"Active Directory Service"
],
"summary": "Active Directory User Delete",
"description": "Removes mapping of existing Active Directory Domain Services (AD DS) User Principal Name (UPN) from the TCPWave IPAM. Beloew example shows sample example\n[{\n\"dnsIp\": \"192.168.0.215\",\n\"encryption_type\": \"RC4-HMAC-NT\",\n\"id\": 8,\n\"principal_name\": \"TCPWave00001Remote.domain.com\",\n\"principal_type\": \"KRB5_NT_PRINCIPAL\",\n\"realm\": \"DOMAIN.COM\",\n\"service_type\": \"LOCAL\"\n}]",
"operationId": "adUserDelete",
"consumes": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "List of ActiveDirectory details",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Active Directory"
}
}
}
],
"responses": {
"500": {
"description": "TIMS-7003: You are not authorized to perform this operation\nTIMS-1203: Please select an Active Directory user principal (UPN) name to delete. "
}
}
}
},
"/activedirectory/authenticate": {
"post": {
"tags": [
"Active Directory Service"
],
"summary": "Authenticate Active Directory User",
"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.\n Below example shows sample request JSON: \n {\"service_type\":\"DNS\",\"principal_name\":\"DEV-DNSROOT-AUTH-001.plab.tcpwave.com\",\"principal_type\":\"KRB5_NT_PRINCIPAL\",\"realm\":\"TCPWAVE.COM\",\"dnsIp\":\"10.1.10.187\",\"encryption_type\":\"RC4-HMAC-NT\",\"dc_ip\":\"10.1.10.170\"}",
"operationId": "adUserAuthenticate",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "ActiveDirectory details",
"required": true,
"schema": {
"$ref": "#/definitions/Active Directory"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "string"
}
},
"500": {
"description": "TIMS-1207: Please select an Active Directory user principal name (UPN) for authentication, "
}
}
}
},
"/admingroup/delete": {
"post": {
"tags": [
"Admin Group Service"
],
"summary": "Admin Group 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. \n Below example shows sample request JSON: \n{\"name\":\"QA Admin group-1\",\"organization_name\":\"QAOrg\"}",
"operationId": "del",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "id",
"in": "query",
"description": "Admin Group ID",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "name",
"in": "query",
"description": "Admin Group Name",
"required": true,
"type": "string"
},
{
"name": "organization_id",
"in": "query",
"description": "Organization ID associated with Admin Group",
"required": false,
"type": "string"
},
{
"name": "organization_name",
"in": "query",
"description": "Organization Name associated with Admin Group",
"required": true,
"type": "string"
}
],
"responses": {
"500": {
"description": "TIMS-1140: Both admin group id and name cannot be null, TIMS-1141: Admin group does not exist, TIMS-1143: Admin group cannot be deleted as it is associated with existing users. "
}
}
}
},
"/admingroup/update": {
"post": {
"tags": [
"Admin Group Service"
],
"summary": "Admin Group Modify",
"description": "Updates 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.\n Below example shows sample request JSON: \n{ \"*name\"*:\"QA Admin group-1\", \"*oldName\"*:\"*QA Admin group\"*, \"*organization_name\"*:\"*QAOrg\"* \"description\":\"Admin group\"}",
"operationId": "edit",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/Admin Group"
}
}
],
"responses": {
"500": {
"description": "TIMS-1101: Cannot find organization, TIMS-1100: Both organization name and id cannot be null, TIMS-1142: Admin group does not exist"
}
}
}
},
"/admingroup/search": {
"get": {
"tags": [
"Admin Group Service"
],
"summary": "Search Admin Group",
"description": "Search all admin groups associated with an organization in the TCPWave IPAM. ",
"operationId": "adminGroupPage",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "total result pages",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "rows",
"in": "query",
"description": "rows per page",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/PagedListAdmin Group"
}
}
}
}
},
"/admingroup/get": {
"get": {
"tags": [
"Admin Group Service"
],
"summary": "Admin Group Details",
"description": "Obtains details 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.",
"operationId": "get",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "TIMS-Session-Token",
"in": "header",
"description": "Session token for authorization",
"required": false,
"type": "string"
},
{
"name": "admin_group_id",
"in": "query",
"description": "Admin Group ID",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "admin_group_name",
"in": "query",
"description": "Admin Group Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Admin Group"
}
},
"500": {
"description": "TIMS-1101: Cannot find organization."
}
}
}
},
"/admingroup/list": {
"get": {
"tags": [
"Admin Group Service"
],
"summary": "Admin Group 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.",
"operationId": "list",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "org_id",
"in": "query",
"description": "Organization ID",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "org_name",
"in": "query",
"description": "Organization Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Admin Group"
}
}
},
"500": {
"description": "TIMS-1354: Organization does not exist."
}
}
}
},
"/admingroup/add": {
"post": {
"tags": [
"Admin Group Service"
],
"summary": "Admin Group 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.\n Below example shows sample request JSON: \n{ \"*name\"*:\"QA Admin group\", \"*organization_name\"*:\"QAOrg\", \"*description\"*:\"*Admin group\"* }",
"operationId": "create",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/Admin Group"
}
}
],
"responses": {
"500": {
"description": "TIMS-1101: Cannot find organization, TIMS-1100: Both organization name and id cannot be null, TIMS-1401: Admin group already defined"
}
}
}
},
"/alarmSubscription/categoryList": {
"get": {
"tags": [
"Alarm Subscription Service"
],
"summary": "Threshold Category List",
"description": "Obtains a list of monitored service categories to subscribe for email notifications in the TCPWave IPAM.",
"operationId": "categoryList",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"500": {
"description": "TIMS-7003: You are not authorized to perform this operation"
}
}
}
},
"/alarmSubscription/thresholdList": {
"get": {
"tags": [
"Alarm Subscription Service"
],
"summary": "List Monitoring Services",
"description": "Obtains a list of monitoring services for the given category to subscribe for alarm notifications in the TCPWave IPAM.",
"operationId": "listCategoryMonitorService",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "category",
"in": "query",
"description": "Category",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Monitor Information"
}
}
},
"500": {
"description": "TIMS-7003: You are not authorized to perform this operation"
}
}
}
},
"/alarmSubscription/componentList": {
"get": {
"tags": [
"Alarm Subscription Service"
],
"summary": "List Alarm Subscription Components",
"description": "Obtains a list of components such as Network, Subnet, Zone, IPAM etc for the given monitoring services in the TCPWave IPAM.",
"operationId": "listComponents",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "serviceList",
"in": "query",
"description": "Comma separated list of monitoring services",
"required": true,
"type": "string"
},
{
"name": "orgName",
"in": "query",
"description": "Organization name",
"required": true,
"type": "string"
},
{
"name": "draw",
"in": "query",
"description": "Page Draw Param",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "start",
"in": "query",
"description": "Starting Appliance Group Range",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "length",
"in": "query",
"description": "Page Length",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "filterRules",
"in": "query",
"description": "Filter String",
"required": false,
"type": "string"
},
{
"name": "sort",
"in": "query",
"description": "Sort String",
"required": false,
"type": "string"
},
{
"name": "order",
"in": "query",
"description": "Sort Order(asc/desc)",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/PaginatedListComponent"
}
},
"500": {
"description": "TIMS-7003: You are not authorized to perform this operation"
}
}
}
},
"/alarmSubscription/add": {
"post": {
"tags": [
"Alarm Subscription Service"
],
"summary": "Add Alarm Subscriptions",
"description": "Create alarm subscriptions in the TCPWave IPAM. Alarm Subscriptions are used to send email notifications to the subscribed users in the TCPWave IPAM. ",
"operationId": "addSubscriptions",
"consumes": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Subscription List",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Alarm Subscription"
}
}
}
],
"responses": {
"500": {
"description": "TIMS-7003: You are not authorized to perform this operation,TIMS-8338: Alarm Subscription does not exist,8339 = TIMS-8339: Alarm Component type does not exist,8340 = TIMS-8340: Monitoring threshold does not exist."
}
}
}
},
"/alarmSubscription/delete": {
"post": {
"tags": [
"Alarm Subscription Service"
],
"summary": "Delete Alarm Subscriptions",
"description": "Delete alarm subscriptions from the TCPWave IPAM. Alarm Subscriptions are used to send email notifications to the subscribed users in the TCPWave IPAM. ",
"operationId": "deleteSubscription",
"consumes": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "List of alarm subscriptions",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Alarm Subscription"
}
}
}
],
"responses": {
"500": {
"description": "TIMS-7003: You are not authorized to perform this operation,TIMS-8338: Alarm Subscription does not exist,8339 = TIMS-8339: Alarm Component type does not exist."
}
}
}
},
"/alarmSubscription/list": {
"get": {
"tags": [
"Alarm Subscription Service"
],
"summary": "Subscription List",
"description": "Provides the list of all available subscriptions in the TCPWave IPAM. Subscriptions are used to send email notifications to the subscribed users in the TCPWave IPAM. ",
"operationId": "list",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "draw",
"in": "query",
"description": "Page Draw Param",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "start",
"in": "query",
"description": "Starting Appliance Group Range",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "length",
"in": "query",
"description": "Page Length",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "filterRules",
"in": "query",
"description": "Filter String",
"required": false,
"type": "string"
},
{
"name": "sort",
"in": "query",
"description": "Sort String",
"required": false,
"type": "string"
},
{
"name": "order",
"in": "query",
"description": "Sort Order(asc/desc)",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/PaginatedListAlarm Subscription"
}
},
"500": {
"description": "TIMS-7003: You are not authorized to perform this operation"
}
}
}
},
"/algo/tsiglist": {
"get": {
"tags": [
"Algorithm Service"
],
"summary": "Algorithm TSIG List",
"description": "Obtains a list of Transaction Signature(TSIG) key algorithms supported by the TCPWave IPAM.",
"operationId": "tsigList",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Algorithm"
}
}
}
}
}
},
"/algo/list": {
"get": {
"tags": [
"Algorithm Service"
],
"summary": "Algorithm List",
"description": "Obtains a list of valid DNS signing algorithms in the TCPWave IPAM.",
"operationId": "list",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Algorithm"
}
}
}
}
}
},
"/appliancegroup/edit": {
"post": {
"tags": [
"Appliance Group Service"
],
"summary": "Edit Appliance Group",
"description": "Updates an existing appliance group in the TCPWave IPAM. Functional and Super Admins can edit an Appliance group in any organization.\n Below example shows sample request JSON: \n {\"name\":\"app-group-1\",\"organization_name\":\"QAOrg\"\"description\":\"Appliance group\"\"prevAppGroupName\":\"app-group\",}",
"operationId": "edit",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Group of appliances, using for patch.",
"required": true,
"schema": {
"$ref": "#/definitions/Appliance Group"
}
}
],
"responses": {
"500": {
"description": "A appliance group with the given name already exists."
}
}
}
},
"/appliancegroup/references": {
"get": {
"tags": [
"Appliance Group Service"
],
"summary": "References of Appliance Group",
"description": "Retrieves the list of appliances that are associated to the appliance group in the TCPWave IPAM.",
"operationId": "getApplainceGroupReferences",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "Appliance Group Name",
"required": false,
"type": "string"
},
{
"name": "organization",
"in": "query",
"description": "Organization Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MonitoringHierarchy"
}
}
},
"500": {
"description": "TIMS-12074: Appliance group name cannot be null."
}
}
}
},
"/appliancegroup/get": {
"get": {
"tags": [
"Appliance Group Service"
],
"summary": "Details of Appliance Group",
"description": "Retrieves the details of an appliance group in the TCPWave IPAM.\n Below example shows sample request URL: \n /rest/appliancegroup/get?name=app-group-1256&organization=Internal",
"operationId": "getApplianceGroup",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "Appliance Group Name",
"required": false,
"type": "string"
},
{
"name": "organization",
"in": "query",
"description": "Organization Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Appliance Group"
}
},
"500": {
"description": "TIMS-12074: Appliance group name cannot be null."
}
}
}
},
"/appliancegroup/delete": {
"get": {
"tags": [
"Appliance Group Service"
],
"summary": "Appliance Group Delete",
"description": "Deletes the Appliance group present in the TCPWave IPAM. Functional Admins can delete an Appliance group in any organization. Other Admins can delete the Appliance groups belonging to their organization only.\n Below example shows sample request URL: \n /rest/appliancegroup/delete?name=app-group-new&organization=Internal",
"operationId": "deleteApplianceGroup",
"consumes": [
"text/plain",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "Appliance Group Name",
"required": true,
"type": "string"
},
{
"name": "organization",
"in": "query",
"description": "Organization Name",
"required": true,
"type": "string"
}
],
"responses": {
"500": {
"description": "TIMS-2051: Appliance group is not deleted as it is being used."
}
}
}
},
"/appliancegroup/listbyorg": {
"get": {
"tags": [
"Appliance Group Service"
],
"summary": "Appliance Group List",
"description": "Provides a list of Appliance groups present in an organization.\n Below example shows sample request URL: \n /rest/appliancegroup/listbyorg?organization=QAOrg",
"operationId": "listByOrg",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "organization",
"in": "query",
"description": "Organization Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Appliance Group"
}
}
}
}
}
},
"/appliancegroup/search": {
"get": {
"tags": [
"Appliance Group Service"
],
"summary": "Searches for appliance groups",
"description": "Lists information of appliance groups resulted from global search in TCPWave IPAM.",
"operationId": "applianceGroupSearchPage",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "draw",
"in": "query",
"description": "Page Draw Param",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "start",
"in": "query",
"description": "Starting ApplianceGroup Range",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "length",
"in": "query",
"description": "Page Length",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "user_id",
"in": "query",
"description": "userId",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "filterRules",
"in": "query",
"description": "Filter String",
"required": false,
"type": "string"
},
{
"name": "sort",
"in": "query",
"description": "Sort String",
"required": false,
"type": "string"
},
{
"name": "order",
"in": "query",
"description": "Sort Order(asc/desc)",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/PaginatedListAppliance Group"
}
}
}
}
},
"/appliancegroup/list": {
"get": {
"tags": [
"Appliance Group Service"
],
"summary": "List Appliance Group",
"description": "Provides a list of Appliance groups present in the TCPWave IPAM.",
"operationId": "list",
"consumes": [
"text/plain"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "draw",
"in": "query",
"description": "Page Draw Param",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "start",
"in": "query",
"description": "Starting Appliance Group Range",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "length",
"in": "query",
"description": "Page Length",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "filterRules",
"in": "query",
"description": "Filter String",
"required": false,
"type": "string"
},
{
"name": "sort",
"in": "query",
"description": "Sort String",
"required": false,
"type": "string"
},
{
"name": "order",
"in": "query",
"description": "Sort Order(asc/desc)",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/PaginatedListAppliance Group"
}
}
}
}
},
"/appliancegroup/add": {
"post": {
"tags": [
"Appliance Group Service"
],
"summary": "Add Appliance Group",
"description": "Creates a new appliance group in the TCPWave IPAM. Functional admins can add an appliance group in any organization. Super admins can add an appliance group in their own organization only.\n Below example shows sample request JSON: \n{\"name\":\"app-group\",\"organization_name\":\"QAOrg\",\"description\":\"Appliance group\"}",
"operationId": "create",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parame