servers
Manage server hardware, configuration, and services.
get /disks
List of all disks across all servers.
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
get /servers
List all servers.
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
delete /disks/wipe
Wipe disks on servers.
Parameters
body object
Request to wipe several disks
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"disks": [
{
"disk": 42,
"serial": "string",
"server": 42,
"destroy": true
}
]
}
get /disks/paths
List of all known multipath disk paths across all servers.
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
get /servers/ips
List all IP addresses in use.
Responses
default response
default response
object
Examples
No request body required
get /servers/nics
List all nics.
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
get /servers/free-ips
List free IP addresses in a subnet.
Parameters
subnet string query
limit integer query
Responses
default response
default response
array
Array of string items
Examples
No request body required
get /servers/{id}/nics
List nics on the server.
Parameters
id integer path Required
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
post /disks/replace-osds
Replace an OSDs by creating one on another disk.
Parameters
body object
Responses
default response
default response
object
Examples
Request Body
{
"osds": [
{
"osd": 42,
"disk": 42,
"dbDisk": 42,
"walDisk": 42,
"encrypted": true,
"keepDbWal": true,
"resizeOsd": true
}
]
}
get /server-access/keys
Get the SSH keys allowed to access the managed servers.
Responses
default response
default response
array
Array of string items
Examples
No request body required
put /server-access/keys
Replace all SSH keys allowed to access the managed servers.
Parameters
body object
List of SSH keys allowed to access managed servers.
Examples
Request Body
{
"keys": [
"string"
]
}
get /servers/{id}/disks
List disks on the server.
Parameters
id integer path Required
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
post /disks/install-croit
Install croit to disks.
Parameters
body object
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"disks": [
{
"disk": 42,
"server": 42
}
]
}
post /servers/update-grub
Update GRUB on all boot disks of the given servers.
Parameters
body object
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"servers": [
42
]
}
get /servers/free-ips-obj
List free IP addresses in a subnet.
Parameters
subnet string query
limit integer query
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
get /servers/{id}/services
List services on the server.
Parameters
id integer path Required
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
get /server-access/host-keys
Get the SSH host keys configured on the servers as pairs of key type, public key.
Responses
default response
default response
object
Examples
No request body required
get /server-access/passwords
Get server passwords.
Responses
default response
default response
object
Passwords to access servers.
Examples
No request body required
patch /server-access/passwords
Set server passwords
Parameters
body object
Passwords to access servers.
Responses
default response
default response
object
Examples
Request Body
{
"ipmiPassword": "string",
"rootPassword": "string"
}
get /servers/ips-with-subnet
List all used IP addresses with their subnet.
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
post /servers/{serverId}/ssh-test
Simple ssh test
Parameters
serverId integer path Required
daosId integer path Required
DAOS cluster ID in croit.
sleep integer query
How many seconds to sleep for, repeated 5 times.
retry boolean query
Use SSH with retries.
Examples
No request body required
get /servers/{id}/nics/{nicId}/vlans
List vlans configured on the nic.
Parameters
id integer path Required
nicId integer path Required
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
post /servers/{serverId}/services/rbd-mirror
Start a rbd mirror daemon on the server. Only one rbd mirror daemon is allowed to run on each server.
Parameters
serverId integer path Required
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
No request body required
post /servers/{serverId}/services/{serviceId}/stop
Stop a service.
Parameters
serverId integer path Required
serviceId integer path Required
Examples
No request body required
post /servers/{serverId}/services/{serviceId}/start
Start a service.
Parameters
serverId integer path Required
serviceId integer path Required
Examples
No request body required
post /servers/{serverId}/services/{serviceId}/restart
Restart a service.
Parameters
serverId integer path Required
serviceId integer path Required
Examples
No request body required
post /servers/{serverId}/services/{type}/{serviceId}/stop
Stop a service or OSD.
Parameters
serverId integer path Required
type enum path Required
osdsmonsradosgwsmdsmgrsnfs_gatewaysiscsissmbsrbd_mirrorsdaos_serverdaos_agentnvmf_tgts
serviceId integer path Required
The service ID, or in case of an OSD the daemon ID.
Examples
No request body required
post /servers/{serverId}/services/{type}/{serviceId}/start
Start a service or OSD.
Parameters
serverId integer path Required
type enum path Required
osdsmonsradosgwsmdsmgrsnfs_gatewaysiscsissmbsrbd_mirrorsdaos_serverdaos_agentnvmf_tgts
serviceId integer path Required
The service ID, or in case of an OSD the daemon ID.
Examples
No request body required
post /servers/{serverId}/services/{type}/{serviceId}/restart
Restart a service or OSD.
Parameters
serverId integer path Required
type enum path Required
osdsmonsradosgwsmdsmgrsnfs_gatewaysiscsissmbsrbd_mirrorsdaos_serverdaos_agentnvmf_tgts
serviceId integer path Required
The service ID, or in case of an OSD the daemon ID.
Examples
No request body required