@itentialopensource/adapter-tcpwave

{ "openapi": "3.0.0", "info": { "title": "TCPWave RestAPI Store", "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.", "contact": {}, "version": "1.0.0" }, "servers": [ { "url": "https://{defaultHost}", "variables": { "defaultHost": { "default": "www.example.com/tims/rest" } } } ], "paths": { "/acls/create": { "post": { "tags": [ "Acl Service" ], "summary": "aclCreate", "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", "parameters": [], "requestBody": { "description": "ACL details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessControlList%28ACL%29" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} }, "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>" } }, "deprecated": false } }, "/acls/update": { "post": { "tags": [ "Acl Service" ], "summary": "aclUpdate", "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", "parameters": [], "requestBody": { "description": "ACL details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessControlList%28ACL%29" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} }, "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." } }, "deprecated": false } }, "/acls/list": { "get": { "tags": [ "Acl Service" ], "summary": "aclList", "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", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessControlList%28ACL%29" }, "description": "successful operation" } } } }, "500": { "description": "TIMS-2001: ACL(s) not found" } }, "deprecated": false } }, "/acls/get": { "get": { "tags": [ "Acl Service" ], "summary": "aclGet", "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", "parameters": [ { "name": "name", "in": "query", "description": "ACL Name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessControlList%28ACL%29" } } } }, "500": { "description": "TIMS-2001: ACL(s) not found" } }, "deprecated": false } }, "/acls/getreferences": { "get": { "tags": [ "Acl Service" ], "summary": "aclGetReferences", "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", "parameters": [ { "name": "name", "in": "query", "description": "ACL Name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "500": { "description": "TIMS-12004: ACL Reference(s) not found." } }, "deprecated": false } }, "/acls/multidelete": { "post": { "tags": [ "Acl Service" ], "summary": "aclMultiDelete", "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", "parameters": [], "requestBody": { "description": "List of ACL names", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "List of ACL names" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} }, "500": { "description": "TIMS-2001: ACL(s) not found,\n TIMS-1307: Root zone(s) does(do) not exist." } }, "deprecated": false } }, "/acls/search": { "get": { "tags": [ "Acl Service" ], "summary": "aclPage", "description": "Provides the list of searched Access Control List(ACL) on search screen in the TCPWave IPAM.", "operationId": "aclPage", "parameters": [ { "name": "page", "in": "query", "description": "Page Number", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "rows", "in": "query", "description": "Number of Rows", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedListAccessControlList%28ACL%29" } } } } }, "deprecated": false } }, "/activedirectory/useradd": { "post": { "tags": [ "Active Directory Service" ], "summary": "adUserAdd", "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", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveDirectory" } } }, "required": false }, "responses": { "200": { "description": "", "headers": {} }, "500": { "description": "TIMS-7003: You are not authorized to perform this operation, TIMS-1312: Duplicate entry." } }, "deprecated": false } }, "/activedirectory/userlist": { "get": { "tags": [ "Active Directory Service" ], "summary": "adUserList", "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", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveDirectory" }, "description": "successful operation" } } } } }, "deprecated": false } }, "/activedirectory/delete": { "post": { "tags": [ "Active Directory Service" ], "summary": "adUserDelete", "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", "parameters": [], "requestBody": { "description": "List of ActiveDirectory details", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveDirectory" }, "description": "List of ActiveDirectory details" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} }, "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. " } }, "deprecated": false } }, "/activedirectory/authenticate": { "post": { "tags": [ "Active Directory Service" ], "summary": "adUserAuthenticate", "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", "parameters": [], "requestBody": { "description": "ActiveDirectory details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveDirectory" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "string", "description": "successful operation" } } } }, "500": { "description": "TIMS-1207: Please select an Active Directory user principal name (UPN) for authentication, " } }, "deprecated": false } }, "/admingroup/delete": { "post": { "tags": [ "Admin Group Service" ], "summary": "del", "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", "parameters": [ { "name": "id", "in": "query", "description": "Admin Group ID", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Admin Group Name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "organization_id", "in": "query", "description": "Organization ID associated with Admin Group", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "organization_name", "in": "query", "description": "Organization Name associated with Admin Group", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} }, "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. " } }, "deprecated": false } }, "/admingroup/update": { "post": { "tags": [ "Admin Group Service" ], "summary": "edit", "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", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminGroup" } } }, "required": false }, "responses": { "200": { "description": "", "headers": {} }, "500": { "description": "TIMS-1101: Cannot find organization, TIMS-1100: Both organization name and id cannot be null, TIMS-1142: Admin group does not exist" } }, "deprecated": false } }, "/admingroup/search": { "get": { "tags": [ "Admin Group Service" ], "summary": "adminGroupPage", "description": "Search all admin groups associated with an organization in the TCPWave IPAM. ", "operationId": "adminGroupPage", "parameters": [ { "name": "page", "in": "query", "description": "total result pages", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "rows", "in": "query", "description": "rows per page", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedListAdminGroup" } } } } }, "deprecated": false } }, "/admingroup/get": { "get": { "tags": [ "Admin Group Service" ], "summary": "get", "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", "parameters": [ { "name": "TIMS-Session-Token", "in": "header", "description": "Session token for authorization", "style": "simple", "schema": { "type": "string" } }, { "name": "admin_group_id", "in": "query", "description": "Admin Group ID", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "admin_group_name", "in": "query", "description": "Admin Group Name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminGroup" } } } }, "500": { "description": "TIMS-1101: Cannot find organization." } }, "deprecated": false } }, "/admingroup/list": { "get": { "tags": [ "Admin Group Service" ], "summary": "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", "parameters": [ { "name": "org_id", "in": "query", "description": "Organization ID", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "org_name", "in": "query", "description": "Organization Name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminGroup" }, "description": "successful operation" } } } }, "500": { "description": "TIMS-1354: Organization does not exist." } }, "deprecated": false } }, "/admingroup/add": { "post": { "tags": [ "Admin Group Service" ], "summary": "create", "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", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminGroup" } } }, "required": false }, "responses": { "200": { "description": "", "headers": {} }, "500": { "description": "TIMS-1101: Cannot find organization, TIMS-1100: Both organization name and id cannot be null, TIMS-1401: Admin group already defined" } }, "deprecated": false } }, "/alarmSubscription/categoryList": { "get": { "tags": [ "Alarm Subscription Service" ], "summary": "categoryList", "description": "Obtains a list of monitored service categories to subscribe for email notifications in the TCPWave IPAM.", "operationId": "categoryList", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "successful operation" } } } }, "500": { "description": "TIMS-7003: You are not authorized to perform this operation" } }, "deprecated": false } }, "/alarmSubscription/thresholdList": { "get": { "tags": [ "Alarm Subscription Service" ], "summary": "listCategoryMonitorService", "description": "Obtains a list of monitoring services for the given category to subscribe for alarm notifications in the TCPWave IPAM.", "operationId": "listCategoryMonitorService", "parameters": [ { "name": "category", "in": "query", "description": "Category", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MonitorInformation" }, "description": "successful operation" } } } }, "500": { "description": "TIMS-7003: You are not authorized to perform this operation" } }, "deprecated": false } }, "/alarmSubscription/componentList": { "get": { "tags": [ "Alarm Subscription Service" ], "summary": "listComponents", "description": "Obtains a list of components such as Network, Subnet, Zone, IPAM etc for the given monitoring services in the TCPWave IPAM.", "operationId": "listComponents", "parameters": [ { "name": "serviceList", "in": "query", "description": "Comma separated list of monitoring services", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "orgName", "in": "query", "description": "Organization name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "draw", "in": "query", "description": "Page Draw Param", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "start", "in": "query", "description": "Starting Appliance Group Range", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "length", "in": "query", "description": "Page Length", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filterRules", "in": "query", "description": "Filter String", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort String", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sort Order(asc/desc)", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListComponent" } } } }, "500": { "description": "TIMS-7003: You are not authorized to perform this operation" } }, "deprecated": false } }, "/alarmSubscription/add": { "post": { "tags": [ "Alarm Subscription Service" ], "summary": "addSubscriptions", "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", "parameters": [], "requestBody": { "description": "Subscription List", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlarmSubscription" }, "description": "Subscription List" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} }, "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." } }, "deprecated": false } }, "/alarmSubscription/delete": { "post": { "tags": [ "Alarm Subscription Service" ], "summary": "deleteSubscription", "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", "parameters": [], "requestBody": { "description": "List of alarm subscriptions", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlarmSubscription" }, "description": "List of alarm subscriptions" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} }, "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." } }, "deprecated": false } }, "/alarmSubscription/list": { "get": { "tags": [ "Alarm Subscription Service" ], "summary": "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": "Getlist", "parameters": [ { "name": "draw", "in": "query", "description": "Page Draw Param", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "start", "in": "query", "description": "Starting Appliance Group Range", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "length", "in": "query", "description": "Page Length", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filterRules", "in": "query", "description": "Filter String", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort String", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sort Order(asc/desc)", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListAlarmSubscription" } } } }, "500": { "description": "TIMS-7003: You are not authorized to perform this operation" } }, "deprecated": false } }, "/algo/tsiglist": { "get": { "tags": [ "Algorithm Service" ], "summary": "tsigList", "description": "Obtains a list of Transaction Signature(TSIG) key algorithms supported by the TCPWave IPAM.", "operationId": "tsigList", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Algorithm" }, "description": "successful operation" } } } } }, "deprecated": false } }, "/algo/list": { "get": { "tags": [ "Algorithm Service" ], "summary": "list", "description": "Obtains a list of valid DNS signing algorithms in the TCPWave IPAM.", "operationId": "Getlist1", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Algorithm" }, "description": "successful operation" } } } } }, "deprecated": false } }, "/appliancegroup/edit": { "post": { "tags": [ "Appliance Group Service" ], "summary": "edit", "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": "Postedit", "parameters": [], "requestBody": { "description": "Group of appliances, using for patch.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplianceGroup" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} }, "500": { "description": "A appliance group with the given name already exists." } }, "deprecated": false } }, "/appliancegroup/references": { "get": { "tags": [ "Appliance Group Service" ], "summary": "getApplainceGroupReferences", "description": "Retrieves the list of appliances that are associated to the appliance group in the TCPWave IPAM.", "operationId": "getApplainceGroupReferences", "parameters": [ { "name": "name", "in": "query", "description": "Appliance Group Name", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "Organization Name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringHierarchy" }, "description": "successful operation" } } } }, "500": { "description": "TIMS-12074: Appliance group name cannot be null." } }, "deprecated": false } }, "/appliancegroup/get": { "get": { "tags": [ "Appliance Group Service" ], "summary": "getApplianceGroup", "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", "parameters": [ { "name": "name", "in": "query", "description": "Appliance Group Name", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "Organization Name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplianceGroup" } } } }, "500": { "description": "TIMS-12074: Appliance group name cannot be null." } }, "deprecated": false } }, "/appliancegroup/delete": { "get": { "tags": [ "Appliance Group Service" ], "summary": "deleteApplianceGroup", "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", "parameters": [ { "name": "name", "in": "query", "description": "Appliance Group Name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "Organization Name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} }, "500": { "description": "TIMS-2051: Appliance group is not deleted as it is being used." } }, "deprecated": false } }, "/appliancegroup/listbyorg": { "get": { "tags": [ "Appliance Group Service" ], "summary": "listByOrg", "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", "parameters": [ { "name": "organization", "in": "query", "description": "Organization Name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplianceGroup" }, "description": "successful operation" } } } } }, "deprecated": false } }, "/appliancegroup/search": { "get": { "tags": [ "Appliance Group Service" ], "summary": "applianceGroupSearchPage", "description": "Lists information of appliance groups resulted from global search in TCPWave IPAM.", "operationId": "applianceGroupSearchPage", "parameters": [ { "name": "draw", "in": "query", "description": "Page Draw Param", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "start", "in": "query", "description": "Starting ApplianceGroup Range", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "length", "in": "query", "description": "Page Length", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "user_id", "in": "query", "description": "userId", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filterRules", "in": "query", "description": "Filter String", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort String", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sort Order(asc/desc)", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListApplianceGroup" } } } } }, "deprecated": false } }, "/appliancegroup/list": { "get": { "tags": [ "Appliance Group Service" ], "summary": "list", "description": "Provides a list of Appliance groups present in the TCPWave IPAM.", "operationId": "Getlist12", "parameters": [ { "name": "draw", "in": "query", "description": "Page Draw Param", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "start", "in": "query", "description": "Starting Appliance Group Range", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "length", "in": "query", "description": "Page Length", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filterRules", "in": "query", "description": "Filter String", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort String", "style": "form", "explode": true, "schem