mirror of
https://github.com/GNS3/gns3-server.git
synced 2024-12-22 22:22:25 +00:00
4.2 KiB
4.2 KiB
/v2/computes
POST /v2/computes
Register a compute
Response status codes
- 201: Compute added
Input
Name | Mandatory | Type | Description |
---|---|---|---|
compute_id | string | Server identifier | |
host | ✔ | string | Server host |
name | string | Server name | |
password | ['string', 'null'] | Password for authentication | |
port | ✔ | integer | Server port |
protocol | ✔ | enum | Possible values: http, https |
user | ['string', 'null'] | User for authentication |
Output
Name | Mandatory | Type | Description |
---|---|---|---|
capabilities | object | Get what a server support | |
compute_id | ✔ | string | Server identifier |
connected | boolean | Whether the controller is connected to the compute or not | |
cpu_usage_percent | ['number', 'null'] | CPU usage of the compute. Read only | |
host | ✔ | string | Server host |
last_error | ['string', 'null'] | Last error on the compute | |
memory_usage_percent | ['number', 'null'] | RAM usage of the compute. Read only | |
name | ✔ | string | Server name |
port | ✔ | integer | Server port |
protocol | ✔ | enum | Possible values: http, https |
user | ['string', 'null'] | User for authentication |
GET /v2/computes
List of computes
Response status codes
- 200: Computes list returned