Chat now with support
Chat with Support

Foglight for Virtualization Enterprise Edition 8.6 - RestAPI Reference Guide

Cartridge

The Cartridge related APIs include the following:

API Name: Get all cartridge’s data
Description: Get data of all cartridges.
API path: /api/v1/cartridge/allCartridges
Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges

Auth-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.

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.

API Name: Get all core cartridge’s data
Description: Get data of all the core cartridges.
API path: /api/v1/cartridge/allCartridges/core
Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/core

Auth-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.

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.

API Name: Get all non-core cartridge’s data
Description: Get data of all the non-core cartridges.
API path: /api/v1/cartridge/allCartridges/nonCore
Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/nonCore

Auth-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.

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.

Registry

The Registry related API includes the following:

API Name: Get all registries’ data
Description: Get data of all registries.
API path: /api/v1/registry/allRegistries
Sample usage: http://<server>:<port>/api/v1/registry/allRegistries

Auth-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.

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.

Remote client

The Remote related API includes the following:

API Name: Get all remote clients’ data
Description: Get data of all the remote clients.
API path: /api/v1/remoteClient/allRemoteClients
Sample usage: http://<server>:<port>/api/v1/remoteClient/allRemoteClients

Auth-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.

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.

Rule

The Rule related APIs include the following:

API Name: Get all rules’ data
Description: Get data of all rules.
API path: /api/v1/rule/allRules
Sample usage: http://<server>:<port>/api/v1/rule/allRules

Auth-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.

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.

API Name: Get rule by ID
Description: Filter out rules by a rule ID.
API path: /api/v1/rule/ruleId
Sample usage: http://<server>:<port>/api/v1/rule/ruleId

Auth-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.

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

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating