setup

Initial setup of croit.

GET /setup/list-interfaces

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/setup/list-interfaces
                

Response 200

ips
array
optional
-
interfaces
array
optional
-
currentInterface
string
optional
-
currentIp
string
optional
-

Example response

{
  "ips": [
    {
      "interfaceName": "string",
      "ip": "string",
      "netmask": 0
    }
  ],
  "interfaces": [
    "string"
  ],
  "currentInterface": "string",
  "currentIp": "string"
}
                  

POST /setup/main-ip

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/setup/main-ip
                

Example body

{
  "interfaceName": "string",
  "ip": "string"
}
                

POST /setup/import-cluster

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/setup/import-cluster
                

Example body

{
  "adminKey": "string",
  "mons": [
    "string"
  ]
}
                

POST /setup/restore-backup

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/setup/restore-backup
                

Example body

{
  "encryptionKey": "string",
  "croitApiToken": "string",
  "backupUuid": "string"
}
                

Response 200

result
object
optional
-
name
string
optional
-
id
integer
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
statusCode
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
object
string
optional
-
output
string
optional
-

Example response

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

POST /setup/restore-unencrypted-backup

Parameters

file
file
formData
optional
croit backup zip file in unencrypted format, must at least contain a database.sql file.

Endpoint

curl -X POST http://mgmt-node:8080/api/setup/restore-unencrypted-backup
                

Response 200

result
object
optional
-
name
string
optional
-
id
integer
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
statusCode
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
object
string
optional
-
output
string
optional
-

Example response

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

GET /setup/ceph-version

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/setup/ceph-version
                

Response 200

cephVersion
string
optional
[NAUTILUS, MIMIC, LUMINOUS]

Example response

{
  "cephVersion": "NAUTILUS"
}
                  

POST /setup/ceph-version

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/setup/ceph-version
                

Example body

{
  "cephVersion": "NAUTILUS"
}
                

GET /setup/available-ceph-versions

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/setup/available-ceph-versions
                

Response 200

Example response

[
  "NAUTILUS"
]