mirror of
https://github.com/ThomasGsp/HyperProxmox.git
synced 2025-02-15 04:32:15 +00:00
74 lines
3.5 KiB
Markdown
74 lines
3.5 KiB
Markdown
# API Information
|
||
|
||
List of all API access available.
|
||
Examples are available in the next page.
|
||
|
||
|
||
### Instance status management
|
||
``` bash
|
||
'/api/v1/instance/id/<MongoID>/status/(start|stop|current|reset|shutdown)' | GET
|
||
'/api/v1/static/instances/<date>|last/<cluster>/<node>/<vmid>/(start|stop|current|reset|shutdown)' | GET
|
||
```
|
||
|
||
|
||
### Cluster management
|
||
``` bash
|
||
'/api/v1/administration/cluster/<cluster>' | GET - Return the informations for an specific cluster
|
||
| PUT - Update the configurations for an specific cluster
|
||
| DELETE - Delete the configuration for an specific cluster
|
||
| POST - Insert a new cluster
|
||
|
||
|
||
'/api/v1/administration/cluster' | GET - Return all clusters information
|
||
| POST - Insert a new cluster
|
||
```
|
||
|
||
### Data
|
||
``` bash
|
||
'/api/v1/administration/purge' | POST - Delete old data
|
||
```
|
||
|
||
### Cache Data - MongoDB
|
||
This data are manage by the crawler, you can't insert or change something yourself
|
||
``` bash
|
||
# date/cluster/node/vmid
|
||
# Disks mapping
|
||
'/api/v1/static/disks/<date>|last/<cluster>/<node>/<vmid>' | GET - Return the informations for an specific disk
|
||
'/api/v1/static/disks/<date>|last/<cluster>/<node>/' | GET - Return all disks used in a node
|
||
'/api/v1/static/disks/<date>|last/<cluster>/' | GET - Return all disks used in a cluster
|
||
'/api/v1/static/disks/<date>|last/' | GET - Return all disks
|
||
|
||
# Storages mapping
|
||
'/api/v1/static/storages/<date>|last/<cluster>/<node>/' | GET - Return all storage used in a node
|
||
'/api/v1/static/storages/<date>|last/<cluster>/' | GET - Return all storages used in a cluster
|
||
'/api/v1/static/storages/<date>|last/' | GET - Return all storages
|
||
|
||
# Instances mapping
|
||
'/api/v1/static/instances/<date>|last/<cluster>/<node>/<vmid>' | GET - Return the informations for an specific instance
|
||
'/api/v1/static/instances/<date>|last/<cluster>/<node>/' | GET - Return all instances for a node
|
||
'/api/v1/static/instances/<date>|last/<cluster>/' | GET - Return all instances for a cluster
|
||
'/api/v1/static/instances/<date>|last/' | GET - Return all instances (the dump can be very big, in a large infrastructure)
|
||
|
||
# Nodes mapping
|
||
'/api/v1/static/nodes/<date>|last/<cluster>/<node>' | GET - Return the informations for an specific node
|
||
'/api/v1/static/nodes/<date>|last/<cluster>/' | GET - Return all nodes for a cluster
|
||
'/api/v1/static/nodes/<date>|last/' | GET - Return all nodes
|
||
|
||
# cluster mapping
|
||
'/api/v1/static/clusters/<date>|last/<cluster>' | GET - Return the insformations for a specific cluster
|
||
'/api/v1/static/clusters/<date>|last/' | GET - Return all cluster informations
|
||
|
||
# date
|
||
'/api/v1/static/dates/(all|last)' | GET - Return all or the last date available (generated by the crawler)
|
||
|
||
# mongoid
|
||
'/api/v1/static/(instances|nodes|clusters|storages|disks)/id/<MongoID>' | GET - Return an information by mongoid
|
||
|
||
|
||
```
|
||
|
||
<\something\> = Change this value
|
||
<\date\>|last = Two way - Use specific timestamp or auto-select the last date
|
||
|
||
|
||
[Usage - logs](06-logs.md) <-- Previous | Next --> [Usage - General](08-usages.md)
|