NSX-T Data Center REST API

List all system health profiles (Deprecated)

List all system health profiles.

Request:

Method:

GET

URI Path(s):

/api/v1/systemhealth/profiles

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/systemhealth/profiles

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

SystemHealthAgentProfileListResult+

SystemHealthAgentProfileListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	System Health Profile List	array of SystemHealthAgentProfile	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results": [{ "id": "72e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "type": "COMPUTE", "display_name": "compute-health-profile", "enabled": false, "plugin_id":"22e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "config": "{\"CHECK_INTERVAL\": 60}", "resource_type": "SystemHealthAgentProfile", "_create_user": "admin", "_create_time": 1557909800701, "_last_modified_user": "admin", "_last_modified_time": 1557909945019, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 2 } ] }

Required Permissions:

read

Feature:

tools_system_health_agent

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable