NVIDIA NEO REST API Guide v2.7.20
NVIDIA NEO REST API Guide v2.7.20

Telemetry Management API

Description

This API is used to manage and develop the telemetry agent image.

Description

Loads a telemetry agent image.

Request URL

POST /neo/actions/telemetry_agent/load

Request

{"object_ids:"system_ips"], 

"object_type":"System"}

Response

{ 

"location": "/neo/app/jobs/job_id",

"objectID": "job_id"

}

Status Codes

Note: For status code 400 see error details in the body

Description

Starts a telemetry agent instance.

Request URL

POST /neo/actions/telemetry_agent/start

Request

{"object_ids:"system_ips"], 

"object_type":"System"}

Response

{ 

"location": "/neo/app/jobs/job_id",

"objectID": "job_id"

}

Status Codes

Note: For status code 400 see error details in the body

Description

Removes the loaded telemetry agent image.

Request URL

POST /neo/actions/telemetry_agent/remove

Request

{"object_ids:"system_ips"], 

"object_type":"System"}

Response

{ 

"location": "/neo/app/jobs/job_id",

"objectID": "job_id"

}

Status Codes

Note: For status code 400 see error details in the body

Description

Stops a telemetry agent instance.

Request URL

POST /neo/actions/telemetry_agent/stop

Request

{"object_ids:"system_ips"], 

"object_type":"System"}

Response

{ 

"location": "/neo/app/jobs/job_id",

"objectID": "job_id"

}

Status Codes

Note: For status code 400 see error details in the body

© Copyright 2023, NVIDIA. Last updated on Nov 16, 2023.