Auto Discovery Status - RESTful API

Summary:

View a summary of the current status of the Auto Discovery, and start a discovery. Applicable to Enuity v19.0 upwards.

URL:

http(s)://{server hostname}/api/autodiscovery

Methods summary

GET Method detail

POST Method detail

PUT Method detail

Methods summary

• GET Method - returns a summary of the current status of the Auto Discovery.
• POST Method - given a profile name, will start a discovery with that profile.
• PUT Method - given a profile name, will stop a discovery with that profile.

GET Method detail

Will show a status summary, displaying the current situation of the discovery, such as any running profiles, and any profiles that are queued to run.

Response:

Example:

INPUT
curl -u admin:admin https://localhost/api/accessTokens?media=json

OUTPUT
{
  "settings" : [ {
  "id" : 5,
  "name" : "default",
  "description" : "Migrated from old discovery: default.cfg",
  "status" : 3,
  "percentage" : 0
}, {
  "id" : 12,
  "name" : "test",
  "description" : "",
  "status" : 2,
  "percentage" : 100
 } ],
}

POST Method detail

Will run the given Auto Discovery profile. If this profile is running already, or is in the queue, then this call will do nothing.

Request:

Response:

Shows the summary if the call was successful.

Example:

INPUT
curl -u admin:admin https://localhost/api/autodiscovery?media=json -X POST –H "content-type:application/json" -d \ '{"id" : "1"}'

OUTPUT
{
  "settings" : [ {
  "id" : 1,
  "name" : "Default", "description" : "Migrated from old discovery: Default.cfg",
  "status" : 1,
  "percentage" : 0  
  } ],
}

PUT Method detail

Will stop the given Auto Discovery profile.

Request:

Response:

Shows the summary if the call was successful.

Example:

INPUT
curl -u admin:admin https://localhost/api/autodiscovery?media=json -X PUT –H "content-type:application/json" -d \ '{"id" : "1"}'

OUTPUT
{
  "settings" : [ {
  "id" : 1,
  "name" : "Default",
  "description" : "Migrated from old discovery: Default.cfg",
  "status" : 3,
  "percentage" : 100
} ],