maintenance | croit API Reference

GET /maintenance/osd-full-ratios

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/maintenance/osd-full-ratios

Response 200

nearfull

number

optional

-

backfillfull

number

optional

-

full

number

optional

-

Example response

{
  "nearfull": 0,
  "backfillfull": 0,
  "full": 0
}

PATCH /maintenance/osd-full-ratios

Parameters

body

object

optional

-

Endpoint

curl -X PATCH http://mgmt-node:8080/api/maintenance/osd-full-ratios

Example body

{
  "nearfull": 0,
  "backfillfull": 0,
  "full": 0
}

POST /maintenance/osd/{osdId}/scrub

Parameters

osdId

integer

path

-

Endpoint

curl -X POST http://mgmt-node:8080/api/maintenance/osd/{osdId}/scrub

POST /maintenance/osd/{osdId}/deep-scrub

Parameters

osdId

integer

path

-

Endpoint

curl -X POST http://mgmt-node:8080/api/maintenance/osd/{osdId}/deep-scrub

GET /maintenance/flags

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/maintenance/flags

Response 200

name

string

optional

-

description

string

optional

-

recommendedState

boolean

optional

-

currentState

boolean

optional

-

Example response

[
  {
    "name": "string",
    "description": "string",
    "recommendedState": true,
    "currentState": true
  }
]

PUT /maintenance/flags/{flag}/set

Parameters

flag

string

path

[noscrub, nodeep-scrub, noout, noup, nodown, noin, nobackfill, norebalance, norecover]

Endpoint

curl -X PUT http://mgmt-node:8080/api/maintenance/flags/{flag}/set

PUT /maintenance/flags/{flag}/unset

Parameters

flag

string

path

[noscrub, nodeep-scrub, noout, noup, nodown, noin, nobackfill, norebalance, norecover]

Endpoint

curl -X PUT http://mgmt-node:8080/api/maintenance/flags/{flag}/unset

GET /maintenance/recovery-speed

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/maintenance/recovery-speed

Response 200

speed

integer

optional

Recovery speed setting from 1 (slowest) to 10 (fastest). Set to <= 0 to restore the default configured in ceph.conf.

Example response

{
  "speed": 0
}

PUT /maintenance/recovery-speed

Parameters

body

object

optional

-

Endpoint

curl -X PUT http://mgmt-node:8080/api/maintenance/recovery-speed

Example body

{
  "speed": 0
}

POST /maintenance/reboot-all-servers

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/maintenance/reboot-all-servers

Response 200

result

object

optional

-

statusCode

integer

optional

-

id

integer

optional

-

done

boolean

optional

-

startedAt

integer

optional

-

startedBy

string

optional

-

name

string

optional

-

state

string

optional

[WAITING, RUNNING, FINISHED, FAILED, CANCELED]

object

string

optional

-

output

string

optional

-

Example response

{
  "result": {},
  "statusCode": 0,
  "id": 0,
  "done": true,
  "startedAt": 0,
  "startedBy": "string",
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string"
}

POST /maintenance/migrations/mimic

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/maintenance/migrations/mimic

Response 200

result

object

optional

-

statusCode

integer

optional

-

id

integer

optional

-

done

boolean

optional

-

startedAt

integer

optional

-

startedBy

string

optional

-

name

string

optional

-

state

string

optional

[WAITING, RUNNING, FINISHED, FAILED, CANCELED]

object

string

optional

-

output

string

optional

-

Example response

{
  "result": {},
  "statusCode": 0,
  "id": 0,
  "done": true,
  "startedAt": 0,
  "startedBy": "string",
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string"
}

POST /maintenance/migrations/nautilus

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/maintenance/migrations/nautilus

Response 200

result

object

optional

-

statusCode

integer

optional

-

id

integer

optional

-

done

boolean

optional

-

startedAt

integer

optional

-

startedBy

string

optional

-

name

string

optional

-

state

string

optional

[WAITING, RUNNING, FINISHED, FAILED, CANCELED]

object

string

optional

-

output

string

optional

-

Example response

{
  "result": {},
  "statusCode": 0,
  "id": 0,
  "done": true,
  "startedAt": 0,
  "startedBy": "string",
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string"
}

POST /maintenance/migrations/octopus

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/maintenance/migrations/octopus

Response 200

result

object

optional

-

statusCode

integer

optional

-

id

integer

optional

-

done

boolean

optional

-

startedAt

integer

optional

-

startedBy

string

optional

-

name

string

optional

-

state

string

optional

[WAITING, RUNNING, FINISHED, FAILED, CANCELED]

object

string

optional

-

output

string

optional

-

Example response

{
  "result": {},
  "statusCode": 0,
  "id": 0,
  "done": true,
  "startedAt": 0,
  "startedBy": "string",
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string"
}

GET /maintenance/migrations

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/maintenance/migrations

Response 200

mimic

boolean

optional

-

nautilus

boolean

optional

-

octopus

boolean

optional

-

Example response

{
  "mimic": true,
  "nautilus": true,
  "octopus": true
}

GET /maintenance/config-backups

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/maintenance/config-backups

Response 200

enabled

boolean

optional

-

lastBackupTimestamp

integer

optional

Timestamp of the last backup, null if never backed up.

lastBackupSize

integer

optional

Size of the last backup in byte, null if never backed up.

lastBackupChecksum

string

optional

SHA256 checksum of the encrypted data of the last backup, null if never backed up.

clusterId

string

optional

-

backupEncryptionKey

string

optional

-

cephFsid

string

optional

-

Example response

{
  "enabled": true,
  "lastBackupTimestamp": 0,
  "lastBackupSize": 0,
  "lastBackupChecksum": "string",
  "clusterId": "string",
  "backupEncryptionKey": "string",
  "cephFsid": "string"
}

PATCH /maintenance/config-backups

Parameters

body

object

optional

-

Endpoint

curl -X PATCH http://mgmt-node:8080/api/maintenance/config-backups

Example body

{
  "enabled": true
}

POST /maintenance/config-backups/create

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/maintenance/config-backups/create

Response 200

result

object

optional

-

statusCode

integer

optional

-

id

integer

optional

-

done

boolean

optional

-

startedAt

integer

optional

-

startedBy

string

optional

-

name

string

optional

-

state

string

optional

[WAITING, RUNNING, FINISHED, FAILED, CANCELED]

object

string

optional

-

output

string

optional

-

Example response

{
  "result": {},
  "statusCode": 0,
  "id": 0,
  "done": true,
  "startedAt": 0,
  "startedBy": "string",
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string"
}

POST /maintenance/config-backups/generate-new-key

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/maintenance/config-backups/generate-new-key

Response 200

result

object

optional

-

statusCode

integer

optional

-

id

integer

optional

-

done

boolean

optional

-

startedAt

integer

optional

-

startedBy

string

optional

-

name

string

optional

-

state

string

optional

[WAITING, RUNNING, FINISHED, FAILED, CANCELED]

object

string

optional

-

output

string

optional

-

Example response

{
  "result": {},
  "statusCode": 0,
  "id": 0,
  "done": true,
  "startedAt": 0,
  "startedBy": "string",
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string"
}

GET /maintenance/backup

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/maintenance/backup

GET /maintenance/backup/basic-auth

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/maintenance/backup/basic-auth

GET /maintenance/croit-auto-update

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/maintenance/croit-auto-update

Response 200

enabled

boolean

optional

True if this schedule is enabled

cron

string

optional

Cron string for the schedule.

registry

string

optional

The docker registry.

registryUsername

string

optional

The docker registry username.

registryPassword

string

optional

The docker registry password.

imageName

string

optional

The name of the docker image.

croitTag

string

optional

The docker image tag.

Example response

{
  "enabled": true,
  "cron": "string",
  "registry": "string",
  "registryUsername": "string",
  "registryPassword": "string",
  "imageName": "string",
  "croitTag": "string"
}

PUT /maintenance/croit-auto-update

Parameters

body

object

optional

Schedule the automatic update of the croit docker image.

Endpoint

curl -X PUT http://mgmt-node:8080/api/maintenance/croit-auto-update

Example body

{
  "enabled": true,
  "cron": "string",
  "registry": "string",
  "registryUsername": "string",
  "registryPassword": "string",
  "imageName": "string",
  "croitTag": "string"
}

POST /maintenance/update-now

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/maintenance/update-now

Response 200

result

object

optional

-

statusCode

integer

optional

-

id

integer

optional

-

done

boolean

optional

-

startedAt

integer

optional

-

startedBy

string

optional

-

name

string

optional

-

state

string

optional

[WAITING, RUNNING, FINISHED, FAILED, CANCELED]

object

string

optional

-

output

string

optional

-

Example response

{
  "result": {},
  "statusCode": 0,
  "id": 0,
  "done": true,
  "startedAt": 0,
  "startedBy": "string",
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string"
}

GET /modules

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/modules

Response 200

enabledModules

array

optional

-

disabledModules

array

optional

-

Example response

{
  "enabledModules": [
    "string"
  ],
  "disabledModules": [
    {
      "name": "string",
      "canRun": true,
      "errorString": "string",
      "moduleOptions": {}
    }
  ]
}

GET /modules/services

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/modules/services

Response 200

Example response

{}

PUT /modules/dashboard/enable

Parameters

No parameters...

Endpoint

curl -X PUT http://mgmt-node:8080/api/modules/dashboard/enable

Response 200

result

object

optional

-

statusCode

integer

optional

-

id

integer

optional

-

done

boolean

optional

-

startedAt

integer

optional

-

startedBy

string

optional

-

name

string

optional

-

state

string

optional

[WAITING, RUNNING, FINISHED, FAILED, CANCELED]

object

string

optional

-

output

string

optional

-

Example response

{
  "result": {},
  "statusCode": 0,
  "id": 0,
  "done": true,
  "startedAt": 0,
  "startedBy": "string",
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string"
}

PUT /modules/dashboard/disable

Parameters

No parameters...

Endpoint

curl -X PUT http://mgmt-node:8080/api/modules/dashboard/disable

GET /modules/dashboard/users

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/modules/dashboard/users

Response 200

croitImport

boolean

optional

-

roles

array

optional

-

username

string

optional

-

lastUpdate

integer

optional

-

name

string

optional

-

password

string

optional

-

email

string

optional

-

Example response

[
  {
    "croitImport": true,
    "roles": [
      "string"
    ],
    "username": "string",
    "lastUpdate": 0,
    "name": "string",
    "password": "string",
    "email": "string"
  }
]

PUT /modules/dashboard/users/{username}

Parameters

username

string

path

-

body

object

optional

-

Endpoint

curl -X PUT http://mgmt-node:8080/api/modules/dashboard/users/{username}

Example body

{
  "password": "string"
}

DELETE /modules/dashboard/users/{username}

Parameters

username

string

path

-

Endpoint

curl -X DELETE http://mgmt-node:8080/api/modules/dashboard/users/{username}

PATCH /modules/dashboard/users/{username}

Parameters

username

string

path

-

body

object

optional

-

Endpoint

curl -X PATCH http://mgmt-node:8080/api/modules/dashboard/users/{username}

Example body

{
  "password": "string",
  "passwordHash": "string",
  "setRoles": [
    "string"
  ],
  "addRoles": [
    "string"
  ],
  "delRoles": [
    "string"
  ]
}

GET /modules/dashboard/roles

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/modules/dashboard/roles

Response 200

scopesPermissions

object

optional

-

name

string

optional

-

description

string

optional

-

Example response

[
  {
    "scopesPermissions": {},
    "name": "string",
    "description": "string"
  }
]

PUT /modules/dashboard/roles/{rolename}

Parameters

rolename

string

path

-

body

object

optional

-

Endpoint

curl -X PUT http://mgmt-node:8080/api/modules/dashboard/roles/{rolename}

Example body

{
  "description": "string",
  "permissions": {}
}

DELETE /modules/dashboard/roles/{rolename}

Parameters

rolename

string

path

-

Endpoint

curl -X DELETE http://mgmt-node:8080/api/modules/dashboard/roles/{rolename}

PATCH /modules/dashboard/roles/{rolename}

Parameters

rolename

string

path

-

body

object

optional

-

Endpoint

curl -X PATCH http://mgmt-node:8080/api/modules/dashboard/roles/{rolename}

Example body

{
  "addPerms": {},
  "delPerms": [
    "string"
  ]
}

PUT /modules/balancer/enable

Parameters

No parameters...

Endpoint

curl -X PUT http://mgmt-node:8080/api/modules/balancer/enable

PUT /modules/balancer/disable

Parameters

No parameters...

Endpoint

curl -X PUT http://mgmt-node:8080/api/modules/balancer/disable

GET /modules/crashes

Parameters

show-all

boolean

query

optional

Include archived and old crashes (older than 2 weeks with default config)

Endpoint

curl -X GET http://mgmt-node:8080/api/modules/crashes?show-all=true

Response 200

crashes

array

optional

-

Example response

{
  "crashes": [
    {
      "id": "string",
      "timestamp": 0,
      "process": "string",
      "hostname": "string",
      "archived": true
    }
  ]
}

GET /modules/crashes/{crashId}

Parameters

crashId

string

path

Id of the crash as returned by /crashes

Endpoint

curl -X GET http://mgmt-node:8080/api/modules/crashes/{crashId}

Response 200

Example response

{}

POST /modules/crashes/{crashId}/archive

Parameters

crashId

string

path

Id of the crash as returned by /crashes

Endpoint

curl -X POST http://mgmt-node:8080/api/modules/crashes/{crashId}/archive

POST /modules/crashes/archive-all

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/modules/crashes/archive-all

GET /netping/metrics

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/netping/metrics

Response 200

enable

boolean

optional

-

network

integer

optional

-

Example response

{
  "enable": true,
  "network": 0
}

PUT /netping/metrics

Parameters

body

object

optional

-

Endpoint

curl -X PUT http://mgmt-node:8080/api/netping/metrics

Example body

{
  "enable": true,
  "network": 0
}

GET /netping/metrics/summary

Parameters

startTime

integer

query

optional

-

endTime

integer

query

optional

-

Endpoint

curl -X GET http://mgmt-node:8080/api/netping/metrics/summary?startTime=0&endTime=0

Response 200

fromId

integer

optional

-

toId

integer

optional

-

median

number

optional

-

dropPercent

number

optional

-

Example response

[
  {
    "fromId": 0,
    "toId": 0,
    "median": 0,
    "dropPercent": 0
  }
]

POST /netping/ping

Parameters

body

object

optional

-

Endpoint

curl -X POST http://mgmt-node:8080/api/netping/ping

Example body

{
  "count": 0,
  "period": 0,
  "fromId": 0,
  "toIds": [
    0
  ],
  "network": 0
}

Response 200

Example response

{}