Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Parameter:
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Clear alarm by alarm ID • API Name: Clear alarm by alarm ID • Description: Clear an alarm by its ID. • Request type: GET • API path: /api/v1/alarm/clear/alarmId Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get alarm by alarm ID • API Name: Get alarm by alarm ID • Description: Filter out alarms by alarm ID. • Request type: GET • API path: /api/v1/alarm/alarmId • Sample usage: http://<server>:<port>/api/v1/alarm/1f478dec-f920-4da9-a8d2-b9ba0dcd4394 • Header:
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Parameter: Field Type Description Content- Type String • Data format = JSON, this value is “application/json”. • Data format = XML, this value is “application/xml”. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Topology — Push data • API Name: Push data • Description: Push data to an existing topology object. The request body should be RAW data and the basic format can be set as below: {
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. We are more than just a name We are on a quest to make your information technology work harder for you. That is why we build community- driven software solutions that help you spend less time on IT administration and more time on business innovation. We help you modernize your data center, get you to the cloud quicker and provide the expertise, security and accessibility you need to grow your data-driven business. Combined with Quest’s invitation to the global community to be a part of its innovation, and our firm commitment to ensuring customer satisfaction, we continue to deliver solutions that have a real impact on our customers today and leave a legacy we are proud of. We are challenging the status quo by transforming into a new software company. And as your partner, we work tirelessly to make sure your information technology is designed for you and by you. This is our mission, and we are in this together. Welcome to a new Quest. You are invited to Join the Innovation™. Our brand, our vision. Together. Our logo reflects our story: innovation, community and support. An important part of this story begins with the letter
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. Content- Type String • Data format = JSON, this value is application/json”. • Data format = XML, this value is “application/xml”. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge The Cartridge related APIs include the following: • Cartridge — Get all cartridges’ data • Cartridge — Get all core cartridges’ data • Cartridge — Get all non-core cartridges’ data Cartridge — Get all cartridges’ data • API Name: Get all cartridge’s data • Description: Get data of all cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all core cartridges’ data • API Name: Get all core cartridge’s data • Description: Get data of all the core cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges/core • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/core • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all non-core cartridges’ data • API Name: Get all non-core cartridge’s data • Description: Get data of all the non-core cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges/nonCore • Sample usage: http://<server>:<port>/api/v1...
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. • Parameter:
Field Type Description param String This value is optional and depends whether the naming script has parameter. Separate multiple parameters by commas. Subscribe alarm The Subscribe related APIs include the following: • Subscribe alarm — Disconnect SSE • Subscribe alarm — List SSE • Subscribe alarm — Subscribe alarms by object ID • Subscribe alarm — Subscribe all alarms Subscribe alarm — Disconnect SSE • API Name: Disconnect SSE • Description: Disconnect all the active Server-Sent Events (SSE) subscriptions. • Request type: GET • API path: /api/v1/subscription/disconnect/all/ • Sample usage: http://<server>:<port>/api/v1/subscription/disconnect/all/ • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Subscribe alarm — List SSE • API Name: List SSE • Description: Filter out all the active SSE subscriptions. • Request type: GET • API path: /api/v1/subscription/list/ • Sample usage: http://<server>:<port>/api/v1/subscription/list or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Subscribe alarm — Subscribe alarms by object ID • API Name: Subscribe alarms by object ID • Description: Watch the topology object by its topologyId, and subscribe to alarm-generated events through SSE. When the client is disconnected, there is no retry mechanism to send an event to the client. For more information, visit Server-Sent Events (SSE) Support and Server-Sent Events.
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Topology — Get topology object by ids • API Name: Get topology object by ids • Description: Filter out topology objects by multiple IDs. • Request type: GET • API path: /api/v1/topology/topologyIds • Sample usage: http://<server>:<port>/api/v1/topology/topologyIds?Id=3546fa55-11b6-4943-b7cb- 84ddcf350bc5&Id=67beea68-fa6f-4cd3-b122-dcb20db50360 • Header:
Field Type Description. Id String The topology object ID. This may include multiple IDs. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. range. AGGREGATE_AND_LAST Retrieve the aggregate and last data of an observation based on the time range. LAST_N Retrieve the last N data of the observation based on the time range. If retrievalType is set to LAST_N, you need configure the value of numberOfValue that defines the letter N of LAST_N. • Request type: POST • API path: /api/v1/topology/batchQuery • Sample usage: Generate a post request using the following url: "http://<server>:<port>/api/v1/topology/batchQuery" The basic format of request body can be set as below: {"includes":[{"ids":["ca83d1a2-f04b-483d-b224- 055967777e72"],"observationName":"utilization"}],
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. TopologyType — Get type super type’s information • API Name: Get type super type’s information • Description: Get the information of a type’s parent type. • Request type: GET • API path: /api/v1/type/typeName/super • Sample usage: http://<server>:<port>/api/v1/type/Host/super • Header:
