Management endpoints REST API

Use this REST API to manage management endpoints.

Get all management endpoints

Table 1. Get all management endpoints
REST API information Value Description
URI /admin/resources/management_endpoints  
Method GET  
Returns 200 Returns a list of all management endpoints
404 The management endpoint list was not found
500 Platform System Manager encountered an internal error while processing the request.

Returns a list of management endpoints.

You can use optional parameters to modify the response from GET calls. For more information, see Custom responses from GET calls.

Response body

[
   {
      "vendor_informations": [
         "/admin/resources/vendor_informations/e4a34cd0-c3d9-42fe-9484-302adf0617cc"
      ],
      "created_time_raw": 1467055528811,
      "events": [
      ],
      "mgmt_endpoint_eth_adapters": [
      ],
      "hypervisors": "/admin/resources/hypervisors/5ce28d3c-c167-43fc-a165-cb62c538d3da",
      "isas_rn": 1,
      "state": "available",
      "label_text": "Management Endpoint",
      "stats_agent_state": "unknown",
      "updated_time": "Mon 27 Jun 2016 19:25:28.811 UTC",
      "label_key": "pure0534",
      "version": "2.2.2.0",
      "management_endpoint_memory": [
      ],
      "id": "/admin/resources/management_endpoints/4b6976e2-1172-437e-9a70-edee2234fa25",
      "state_updated_time": 0,
      "machine_type": null,
      "management_endpoint_cpus": [
      ],
      "label_user": "Management Endpoint",
      "updated_time_raw": 1467055528811,
      "locations": [
      ],
      "software_version": "VMware ESXi 6.0.0 build-3620759",
      "name": "SN#172.17.168.19",
      "created_time": "Mon 27 Jun 2016 19:25:28.811 UTC"
   }
]
created_time
The time at which the object is created
hypervisors
The location of the management endpoint
id
The unique ID of the object in the system.
label_key
Key for retrieving the label for the management endpoint
label_text
Default translated message text
label_user
User modified message text
machine_type
The machine type that contains the management endpoint
name
The name of the management endpoint
software_version
The software version for the management endpoint
state
The general availability of the object. If "pending" the object has been created but not activated. If "available" the object is active in the system.
stats_agent_state
The state of the Statistics agent
updated_time
The time at which the object was last updated

Get a specific management endpoint

Table 2. Get a specific management endpoint
REST API information Value Description
URI /admin/resources/management_endpoints/{id}  
Method GET  
Returns 200 The management endpoint was returned.
404 The management endpoint was not found
500 Platform System Manager encountered an internal error while processing the request.

Returns a single management endpoint identified by {id}.

You can use optional parameters to modify the response from GET calls. For more information, see Custom responses from GET calls.