This is the reference documentation for Morio's Core API. It is auto-generated from this API's OpenAPI v3 specification.
With the exception of the /status
endpoint — along with this /docs
endpoint itself — this API is internal to Morio.
In other words, you cannot interact with it, or use it as a regular user, or even an administrator. This documentation serves only those who want to learn how Morio works under the hood.
To learn how to interact with Morio through its user-facing API, refer to the documentation for Morio's Management API instead.
Join cluster
This will cause an ephemeral node to join a cluster
Request Body schema: application/jsonrequired
The data required to join the cluster. Note that this includes the private keys and certificates.
you required | string |
join required | string |
cluster required | string <uuid> |
as required | string Enum: "broker_node" "flanking_node" |
object | |
object | |
headers | object |
Responses
Request samples
- Payload
{- "you": "morio-node2.tokyo.morio.it",
- "join": "morio-node1.tokyo.morio.it",
- "as": "broker_bode",
- "cluster": "3dafca38-993c-4ebf-8613-2d044e1450f4",
- "settings": {
- "serial": 1722353755056,
- "data": {
- "cluster": {
- "name": "Morio Unit Tests",
- "broker_nodes": [
- "unit.test.morio.it"
]
}, - "tokens": {
- "flags": {
- "HEADLESS_MORIO": false,
- "DISABLE_ROOT_TOKEN": false
}, - "secrets": {
- "TEST_SECRET_1": "{\"iv\":\"4b16f0efa70cdcad568441143b0ebbea\",\"ct\":\"28262a424d8b3378b2ac78c7074deeec\"}",
- "TEST_SECRET_2": "{\"iv\":\"bc0fb68aa6f37cc4eda8fca6a50d7448\",\"ct\":\"cc786dfb1c5fe6dd4ad389855a206d57\"}",
- "LDAP_BIND_SECRET": "{\"iv\":\"8b185698a44410657ce84ba6a35b82ce\",\"ct\":\"7ed3e4c461455f3a4a8b44f834935b6b\"}"
}
}, - "iam": {
- "providers": {
- "apikey": {
- "provider": "apikey",
- "id": "apikey",
- "label": "API Key"
}, - "mrt": { },
- "local": {
- "provider": "local",
- "id": "mrt",
- "label": "Morio Account"
}, - "ldap": {
- "provider": "ldap",
- "verify_certificate": false,
- "id": "ldap",
- "label": "LDAP",
- "about": "Test LDAP server",
- "server": {
- "url": "ldap://ldap:10389",
- "bindDN": "uid=admin,ou=system",
- "bindCredentials": "{{{ LDAP_BIND_SECRET }}}",
- "searchBase": "ou=Users,dc=ldap,dc=unit,dc=test,dc=morio,dc=it",
- "searchFilter": "(&(objectclass=person)(uid={{username}}))"
}, - "username_field": "uid",
- "rbac": {
- "manager": {
- "attribute": "employeetype",
- "regex": "^manager$"
}, - "operator": {
- "attribute": "employeetype",
- "regex": "^admin$"
}
}
}
}
}
}, - "keys": {
- "jwt": "eb3be6a4e4a3eb4dfc76202c7a8a0d62294788d8d238ae9d7de9b489b6a6cbf895bb7255e6a67cccab0ddd3ddb1a45bf3d691447c7c91dec333b8724da76c2de",
- "mrt": "mrt.eff7902e0eff6a4ffdaffd84ae5f9fb4ee8d67db07efa561ab28fd3fb3f4ee36",
- "public": "-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAi8sk8Bk3xBB/vSdkqYUV\n7iDFaGg8ser6tBERCV8M0W5e4h9B1MO34HuElEgXGOvQwWRcWkbijxhCfFSW2D4L\nTrJ+FwWENJUMvf7HtEJ9z/iKjNeB5nVDAiu6dNljnht3UILyOWcKrqBt7kWoGZUA\n4e5WvEfQh2OtK/Fd+3Ax5I0jKHUbOIC5lP0qP+S1fakoGGOS/dXDEFO8D5BWMgRe\nVNhWJr1z5NgnWT/yfOhlfSUjqb0qhbljMI1vCpn3vJn8lVgwVd5lhzUFzD0iT25F\ngfhWphWK+XHA3zHYbVTtntEqYz/UxJM57QBbpobJXBHDU9F4FKJKQZOzjbnfnp2y\nmYbIvMmMWARh/BCrjrAR0z+3nM3JKcnoWh0CYCJoRPc8bPkztWc7LXIsxoAgHvk0\neS5Pqd0MqX8zDQ/OsiPLLYODD6INy0m7vOlyHgRE0JS3ZKqNQPVmRGMuV1fvsZEr\nl3xFvkU3EsbSHWJ6/98o0Tndu3sUvdPhsMsn8+3YgDFC6bgCJDvSGelejgTA9OOM\n5BVUfyysC3cc4xDKYU6WLCc0k5li7i/cagGol+M250/mToHV48s8O51M/YMIrwcX\nBKuLgrUen9AD11S83/S/Xqt6+WnjkGlQkCbPvXss31f9OYZfEaYsU17dXprCchPQ\nDgUkm6s56Vz5NNY8KMOiNVECAwEAAQ==\n-----END PUBLIC KEY-----\n",
- "private": "-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIJrTBXBgkqhkiG9w0BBQ0wSjApBgkqhkiG9w0BBQwwHAQIzHVyaL3pdZoCAggA\nMAwGCCqGSIb3DQIJBQAwHQYJYIZIAWUDBAEqBBCPeWS/bmJL9ycL4oPdpCfBBIIJ\nUClykbE+9oS4+dbvZQC3w+u5x8G0c/QpHf43pFF76k+Wu/pv2Sy980bFPs/Hvj0O\nHnyMrqSW3Gta+EHOacjk2Ujd9EMBglbU6PjVMMhZOI5RrNRLH9jQn5nTyFfvtrFH\nazm4NLh84m/FmrmNca7lK+ZSgUZptA032jSuok247jvWgD8GmXBnk16cuhgTyuBy\nLtzISRTy/sk+WF73810dWiv6FKIyfkiNfOO94KE9cT3ErYh7CgtB8oS7pMHkiOeU\nHGdYMFqbhvjbyHQ6JmvxyWXL3W2z2akmTRMLOkDTbW0m92xlzmCfRWnwKN1gO/cK\nSn4YslnrqI8aX+wTqF+b+wSH63u68iSLE2u4Z7YSJTQt1N5TgjN1lkAfCF79GaTn\ny/F7JZuDlHo1BdxWtX5OUZJJhaLp55V5yfD9QUK58W39+JbOMGD4RvYZoALPtZFm\nOds89l0rKivOxRQT4+M6b6ceM0pC06OZNxPQMQcj/ZwfgAlNuxrECq097b/dd2VB\nBsPT3Pk2mq9nycJsyrj6QO3Kn+VnhBRgCfEfP7OcTr2PZOsYH5UH9CDtaijGtBmA\ngb1D6bTJB5Jqr8QfQhZjuAWqE+n4P8XGgHkrvexXfL+/ux/uQLJNhCKIEmk5EcaR\nadAuacB8RsPs7LzZealaBfzUTnzt93qyEGm9vCnhmQKQZryPEbP4d3KrkowKEiXD\n4048yYDgkA+aJ4dbjTtcZPgLNZz4HGD9MuIeWI3TmLjCxTsDWIvZb+m07gtTBrqs\noxli5t5aRDCvjJfFe0lo/Mo2+5fe8FRlY0ilJwgqBTyy8hGOlmhO9eHvPutMoErM\nLsz05hh24G5AwxQIzHWFeoM8hi3La4rPXpU8coVgDg914H4OTU/udtW61SdKpg/y\nrsmrKQ5RI3X1AVtX2/rLsPuNaNB1KvoXmK1Z73nHl1M6MnKJ3G6ekArc6CZAawiX\ntN2j5GMwjA6OdZRG1R/wkkUgIHyh9U3YRpCdIFzs0BB+sWurrbKa+Tb0nZyxFKAj\n/Dq3wFSEM8x2/n4Nod+Ng77kofehof+ZG2CdZuq8CWuNDHB+AhTMtBM7V50pDM73\nd2pSd2iYVuKlW6Wci58XKAlGJWQtS543Ttw1pND3uwg5ByVatGJuhfgT/QniDhfm\nIm+CNSHC5DBZ18uVP4hHHUmTvsqxUsH7ce72RkpDgX8KhEkA2Kl/38WrA7I6NjKX\n91p9gfXJCW1jgZ/qdXZjzObIDavuOf8OncGwXSDgLl8qwjCrRp38hCAWg+24XxHs\nbhoLP36CdQSb+DuABv0LBwuubGaojnmrbpMIOITS4yi1WH1SR1YiehUUBkAwD3FA\nhxGZ1NXJLScRDk9xhG9I9MA/m3k+kLw+MqeLCCU9o1EVUAy5Sn6C5K4Ym/b4c/iB\nV7eplRLAG3ynkt1pspj7W4pGxavHoX4aRdg5/181pSuvNOUl/kNYfdd+m51CCsZP\njMZTGol8ImA3X1P8X7aDvuBm8GJPOQIKCMPhH6oHafaDA724Qhstqq7FAOgHS/cj\nAmPumyPO0Np481M/EHCSawOZ8lHdVW0g2OujbZTOs8qqeWjpV/2htCGH/+xiikss\nLPSdv1oaugQMv6HIA9oHJa0R6ydoKtdQ1i9+EKK1vJbmVWOn5dky3R5p8ZekJtZA\nBbD/hr+q9Ho2GY5d16aJR+DIAW8VJW3oMZC8dg48QNyKfSya6e8AXY70ITUh8O2z\n8RNPmzm+v2bTwXP7CeBCf3vouxrk/Ph9lbhMnKRWsqKxneexlzaIoTP3xS8fOCa6\nxjiX2Z9FiNqoFwxCoFq2pNoba9j9I50cXynsq8W8z50hIerWDlm8HeiWYtUB5pg7\nPoqsbzzf+2b/Ju0yIDRzBs5nFOGVYSucNe4GDo0zjtVKNpNU1nPl1Mszg2b9uI4p\nPu7ibYphDIgHrZAOpwt+nQPgXIG8MrHZ9RQjc4xtb683vWofQxLIc4G1Wyeh4K4l\nFeK6+Yl28GMWIdyLCgJfZWEjkiKaUCl3OPE1gSp2zOJfeCEp2PU6y513uYO2wwsj\nK7vwRFRGvPJE2nxpjYBQVvEsCG30TtDttpMF/AmSHa3e6PHA+2DTG7dApjg0oI72\nmEXODV9S4Wgc7fLSSLN69Smp/YOG06ZJXYsEVzU72IJr63uVJCw37Rray9TmHLHI\nugUHJzbdicN28rbeUhsy32DhWzBaFWsaiX4N/unw3/WfSZxe9IlCs1Yr2oBojzfB\nOmDZFokxVc73w7Vo/7NLYBRBpCaua4IxLrnMAJcEge9Gz9/wtsfWu1cFiLiDf/z5\nzHWsORypgaBVlmEzVnm9xIlLtIWCHKJ1nQ8wcyTb6MP28RKZ6pHlk8X152ITShzt\nStw+0/g2W/mk0p7vclyKIwaEuq4OkqIlNxR1hVJftuaDFLfdgW43FDzdJftl5IfZ\nRauCh4BoGVCh2lnir/eJskfkvc2x0eroLgoa+LMWrrh7zxi+xRBJPMeQMIqI99uT\nvGrCI7NQ8cSZJugta9bb6kQHCB13zAi2jOm0jFrAqvzkmM+6beOooX2Zhz8i49Gv\nExbhnJJQBlHPEKCVWKPNS6P56usEMQx6Eniyobet7o/BT0uswPrB2Xoc0Ql/wK7L\njYdbkcxI4ru6JmL094t/vZ9MRuzSOR7x0isZ6LJXWAh2GYfaXgTlTbwsO+9NJB7/\nvZOsxMXlAvj36b3TaoBmaFrGD3x0gs/OmeJ1jghAoKiC5bs7w7TdtVVSeXvhFkgP\nUf8Zyb6clUHtPYFTTAKrY1fqcSPlcicc1HxTdwXApYs8AkZPs/EaDz399bWdpq8E\njWWzjtr21kSaqHpw5Zt+q2aqpl0H2m4WLXRqRDzdgSRoeIaWUxNI57YLaDlwHniv\nAU89kmtRAfGnRwTJLKrPAugJvgFOanMKIy4cOzMGLqA9ZSY/DBtNTB9g4LwbocBC\nQtFscvv/E6lOyFAe7S3ew45NKr7KiCP42m+D0kix2ObzIj9jV0QojROoa3VB0rqP\nSjzOtGTB7YG1T0MDhmuskrg6bQpUvMjlUhw4HWEgwOa7iSFYTpz0e3orcx05leor\nZKbn4ZYduHftmipxgr1sHjTUXC7Bb4f54m4NFg7HSaVlhTECZUCd1g7uRR8qfbOO\nDmwMs8XbQOWGa8RYrYSiBHRpGf/DImCaa9pC4BihxcvF\n-----END ENCRYPTED PRIVATE KEY-----\n",
- "cluster": "3dafca38-993c-4ebf-8613-2d044e1450f4",
- "jwk": {
- "kty": "RSA",
- "kid": "Lvapo7_9qMOEpK7rH7xS4HvJqM1btSBzS01nciAzHws",
- "n": "i8sk8Bk3xBB_vSdkqYUV7iDFaGg8ser6tBERCV8M0W5e4h9B1MO34HuElEgXGOvQwWRcWkbijxhCfFSW2D4LTrJ-FwWENJUMvf7HtEJ9z_iKjNeB5nVDAiu6dNljnht3UILyOWcKrqBt7kWoGZUA4e5WvEfQh2OtK_Fd-3Ax5I0jKHUbOIC5lP0qP-S1fakoGGOS_dXDEFO8D5BWMgReVNhWJr1z5NgnWT_yfOhlfSUjqb0qhbljMI1vCpn3vJn8lVgwVd5lhzUFzD0iT25FgfhWphWK-XHA3zHYbVTtntEqYz_UxJM57QBbpobJXBHDU9F4FKJKQZOzjbnfnp2ymYbIvMmMWARh_BCrjrAR0z-3nM3JKcnoWh0CYCJoRPc8bPkztWc7LXIsxoAgHvk0eS5Pqd0MqX8zDQ_OsiPLLYODD6INy0m7vOlyHgRE0JS3ZKqNQPVmRGMuV1fvsZErl3xFvkU3EsbSHWJ6_98o0Tndu3sUvdPhsMsn8-3YgDFC6bgCJDvSGelejgTA9OOM5BVUfyysC3cc4xDKYU6WLCc0k5li7i_cagGol-M250_mToHV48s8O51M_YMIrwcXBKuLgrUen9AD11S83_S_Xqt6-WnjkGlQkCbPvXss31f9OYZfEaYsU17dXprCchPQDgUkm6s56Vz5NNY8KMOiNVE",
- "e": "AQAB"
}, - "rfpr": "b677fdebb9ba4e3124723c18981f6aea0a64259d1ccb9559588265be48e5da2e",
- "rcrt": "-----BEGIN CERTIFICATE-----\r\nMIIGojCCBIqgAwIBAgIBATANBgkqhkiG9w0BAQsFADCBljELMAkGA1UEBhMCQkUx\r\nETAPBgNVBAgTCEJydXNzZWxzMREwDwYDVQQHEwhCcnVzc2VsczEZMBcGA1UEChMQ\r\nRW5naW5lZXJpbmcgVGVhbTEbMBkGA1UECxMSTW9yaW8gQ2x1c3RlciBUZXN0MSkw\r\nJwYDVQQDEyBNb3JpbyBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eTAeFw0yNDA3\r\nMzAxNTM1NTlaFw00NDA3MzAxNTM1NTlaMIGWMQswCQYDVQQGEwJCRTERMA8GA1UE\r\nCBMIQnJ1c3NlbHMxETAPBgNVBAcTCEJydXNzZWxzMRkwFwYDVQQKExBFbmdpbmVl\r\ncmluZyBUZWFtMRswGQYDVQQLExJNb3JpbyBDbHVzdGVyIFRlc3QxKTAnBgNVBAMT\r\nIE1vcmlvIFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MIICIjANBgkqhkiG9w0B\r\nAQEFAAOCAg8AMIICCgKCAgEAwefTWGM+YIYqTNPehFpm56wkp8ZDCli5Cq7HWKJi\r\nTtq9w36qIDcbZ1iyCQf/WVCS1dg0YYZXQMsm5oKIyrIMj3ZIhZAeGHvgk1CBO4Mz\r\nl+HJFcYiUIv/CvBuysyCtDzYNtWDRMziZpW5B3bfD9OWFK4PUF2SQRniBJQa1bOQ\r\nDYflKiIfgwQctXrhQrL+sop+5c44JhOdChvhKzwGE8sYaKPj9imOLAbVc+kl5bLH\r\nxz+kuTdfOSL/m6RuuH5dB57DZwSxedbYduBrNnjW6VpNothr8U9jc8BumR/1WGkI\r\nC7hKHe8ViUSoIdu9um8KGdfq2lMY9jIn5msw1De9jyawil6ifD7zJPP5YL4gcY7Y\r\nCKmLhDRpZT/MpZ2/r+Eo1yKxr05XqE43j5D6a6UAFDvjTJIXmXVfcXkdHzN72dq1\r\n6ao748OQthZmYjLJgZndfT6eQZ40mqxcgJV7oXPfVcdXMlvDgKy/QPCDODmPz0f4\r\nNw0q3Se9P4sPIdGDOFvWr4419l0sgBV34ci1mqkTpxXRCs4Kp/PVCV+SBQnAs5VB\r\n+21awR/+WajJ9fxDXdzjaAn42QdtuBzDpvahDKKaUOl5jYyzp+hU3CW9MXL+g0TI\r\nU2yXgVaH9kkSqu4d7YGWc4n4RwilLAkuQ7lJQCfdKV7Qmjhtutn1PHo9YkLjygMj\r\nCd8CAwEAAaOB+DCB9TAMBgNVHRMEBTADAQH/MAsGA1UdDwQEAwIC9DA7BgNVHSUE\r\nNDAyBggrBgEFBQcDAQYIKwYBBQUHAwIGCCsGAQUFBwMDBggrBgEFBQcDBAYIKwYB\r\nBQUHAwgwEQYJYIZIAYb4QgEBBAQDAgD3MB0GA1UdDgQWBBQV07pck74lG665QLsM\r\nf54h1l4kcDBpBgNVHREEYjBggh5wb2MtbW9yaW8tbm9kZTEuY2VydC5ldXJvcGEu\r\nZXWCHnBvYy1tb3Jpby1ub2RlMi5jZXJ0LmV1cm9wYS5ldYIecG9jLW1vcmlvLW5v\r\nZGUzLmNlcnQuZXVyb3BhLmV1MA0GCSqGSIb3DQEBCwUAA4ICAQAAkKHwQMiuHBFJ\r\nsm7nAfzFmxLuIW4n46BmLPYycrXRIncDbBIVa9w+X79Mo26eC0McEnXZ11ZVhD1p\r\ngiRCPY7Wz7vgppidIEplwAbv2//N+jIhjDYz5kOaru+bSaHAQpoL8oQtTsv1PPbg\r\nghDHXrmBtwvbzXz5StBKGlP0PCfTvhHr/kQ+K4BeMKsxwN1znj5vM9xYYmpAgDnb\r\nTawgDtudRMEkEX+UNOjFvu7TWfe/vv4dpKwwYXc0xFO4XTXVC9GevvKQlwAaKmzl\r\nKY0kldV/Y1sIlljPRqi3z8tsdwEf0jsjSNgWNnmDK6z/os4kzKEC4wrJcvMX2BIV\r\nj0ebkdkXaxL5eg1oEqBY8v6M+mfwe1zrN+c3aOVpar32RxAcIa4DoVQPAhZRN2uG\r\n4iOjLPcX4u7Imkzzl+VIewxNoUqu9XpYuztWOhAesrcAyeWmHdWr09pGVmP8LC1x\r\nwVA5JBii7B82BebxBdP5GLXlCpp0Hf4HVgvElE5y+hoMlskzecKK4cpfFxKVq34u\r\n07exDS8M1jqDnfPLWwqap8T6lHVotlV6gvACfUxEBovxEuo7Kp+eh3hXkcOS8Ce1\r\nbjWHXcwc/oawOp1LI9+bK5tr8iUx8L31w+gFmT2+ylVaA48w2dj8kydc87LgzQRh\r\nBHOAdVjaye0aDBXjYUV65VdxN13Rbg==\r\n-----END CERTIFICATE-----\r\n",
- "rkey": "-----BEGIN ENCRYPTED PRIVATE KEY-----\r\nMIIJnzBJBgkqhkiG9w0BBQ0wPDAbBgkqhkiG9w0BBQwwDgQIKPYiuT1VYMECAggA\r\nMB0GCWCGSAFlAwQBAgQQ5NIr6APeGbsoTG7PyWUEPASCCVD+jsTFcWmNtzT000zB\r\nfgDXulA0oYPSOp9wniaz/GAvJLkTd6ecfmsjGMiQocfS20Jp/vZ3AvixKIR50SJD\r\nOE7pkYYl4u6bMSXT4qNbD+5sQ8YVfR8ZUPSSpfaCVqinsE1ihaIx+2T+YjK7vanT\r\napaERkSgyDSXycMkAfqYr4UJbM2uFyWELVLV0hchoKUMabebjhSjkVegq6TYM1IZ\r\nJax1+6en3cULsNNYpPdkSDRGDA0hYRy6JKWt95ZSZExiJg5F12QPLmB7fCtmG7ua\r\nh9Kq/4o8OKV5N44Ki/mS6rDOboxmT9AXmcuuDHgF0pKtwOvtfa13Yy2kJnXU99Kc\r\n7V/JtGAbQNA0gpRaNiv/IJ5tO+KaL/dB5KLiU7uHph+Dhbv0VPlYAA+5H5CGnweY\r\nALbOTWSDgPwivLUgLuqmLutYC/h9D4+IJ01zy2kJe3OACsC/fd+uL+kaZMOq/Bp7\r\nSoRuexD/RoRDF3Kwz0pM+lyJvpWPiOiRyrpEpyH2G8v5eGF5URlEXkI7JzNX8ErY\r\ne1K0BP67sinh7Y5f3IMd9tCYBqMVqPhLUBOMat48xgjnZzWlxEWMK85JZVUyaBUS\r\nOfC1EYalKgEhchfrjCP6cX464ThZ3h2CZuo8DBoMCjHa7HXpowNvLpNpLUMZrN/W\r\ncdKzlDkT0gFM/GhxgVPTkUd+f4hpOA2nQtSv/npAGZFNVPtI+ErOvfQoVBKsgq0P\r\nmo1dkoAt0S4lhiipElWuLOw65G742Hkr4c04tha5fw3+7MV97tNdANQu3z4mh0OL\r\nyV5VdNIebpBKjEku2cc9BXauPEWZPj5LO6ZbqvAyF4aZdoUsEb497qvuTZexSRWx\r\nTv42Vowb7G6xXg9aLFH50D95gVvzf5xnyDWssQJK3ZNk2MUtVhEbx86dctnXnPLO\r\nPQ3lisGboNlgRSJ1oRiyDdD1ROU6e+wjHs6M+ZAqsOeK97xPps/+rebgzrDQbu9d\r\nvoZM4i6U7pxDRTdDXUMjgA7VwyJxAqLAwdcbE/idCyvG8ysni537t6M9et0eOe3w\r\n0kbsuqFBBcfMpOsx7cihRCtoBuMAZDCEG2t1bhutUsWKPl1AKTlyTj2DaQjCi2yj\r\nxhcuJFIx4DmVhUFaKJOEdpdwakqNRgm8qEKhZZ7bre9voYD4B68lWg3BkFzH2nKC\r\n40c3FZn+Sm4OBR7lyx46AMbrimxfMo7QtkmQrrB829jm8rswNJ0h9KPjc9JogqAk\r\ns9iOGuWrMPI8Mf6Zefc4KfnbQB/NsMDWiBkFZZFXOYfNAw3WGa3zPDUZa2VpITUT\r\ngCxxDtcptrPeGvEN7RKgSpoyYhS6FQOUM+G0H56nZFgwu8KG+zZg5NBgGg1QyMIQ\r\n/abVPIb4WkUl7Pq3et5cfJyxGbw21nRHy/tpkcTtvlTMsPFuEFjuhXppsOhcbAgR\r\ng+fm53XCwoDR5/0rezbmjURk8PDnc6LXS5ytHvHTSTEH5y+qf9r4uAoVji/dElds\r\nDbUXCFr2bQBvB9eAbHyp79U6kB80zsgdDKRKcM8YZh2BKy6S8aDERId3EVtUryl0\r\nJFz0Cn7WWTNcENe73Z6/FFOokc55jfKcgol8gM6kcIBHkyJDodbO5MV/YKFHYdCr\r\nF0mD+iNdqpwL+ngUoJm6DTCKdHtM1eYVE0Kasm+rZrSZYK9vtFy5HLKcUC5QeUwl\r\n6phukg/pSAYFnNRHSv/Nf+fZJhR09iDIbGa9401yEOQqCSgy5TRjD6GnwZ+wB79A\r\nrE2eRDcothD4mA0nmJTNbTM8UBvUOGWaWdevwMshugzbIrEcnCj1d0GBJ4O9lXVV\r\nf/SLo7osaw+qmA3528wHAVIuMh1KYKMRjNnXUCVVWWMcuVSMbTd5GqBeweqC5Yq+\r\n7oekspgqRnqtXBxNeAeCXzNKPN2UeGRnrnjNPr9qOHr7z+eUFXdjOWXE9i0h/UMj\r\nkNH7Wtby45lm0qmrOFZcMx1932mrx356harmtCKqYIm+6+rbm9szLggHRMli6y1X\r\ndnG1cNiu5PLPdKHlfwqu+bRiQ8HXv3pQpNbWfKNkkicbuHVnuFFSs5vtTwvUBcHJ\r\nSf3FIErfkipUAP/l5B3ouWMP9hpHRMsU1uyhrVIYYQ8/o0PcbxA8/YxPZ0+y1Y94\r\n5iZdzU7A1p3CYAC/fFfUdTWT6ccvoEXyVPIvW7xKWaQ2Ir+wRF1643PdCfyMCaa6\r\ndW2xCCFq6AO4TT4Nhp9CepAp5BAHNVhQWbGaIAfb1hngI/lza+9sOs6/t4wYMwls\r\nsm5qedSbgjVqFe8GDUiIc5Ga0BtyImLoRFQLCB1kFyyEQ/NAdUFg05/tZJSHqY/w\r\nBLbgA1Ln0fs885IBWoODfIQpX3gydwJcWr2Krz95lAdbcwtlI8io3XjUX5nmFdUe\r\nxRV7g8yQPNODB4LFcRg7Ir0sblWia2OC+8bmhZ8J/wztrTFZQ2XmanXUDlQmWY7z\r\nPCnqofW/5lD5cTglMkq7xboFIty0nnMepXEoyT0b9a7qJRcRIrD0bJ/ZVOHRz/+T\r\nCXdkWTbi9suLyNfhcXb2u3jDvI0xMeXr6Ocp8H53s1hby3lym3cg3+cWUKI4mf3L\r\nlOcuVts0AQgQVdqP6Y+K14I2g9jXoWP+EQd8I3QYHp98tx4YcIRqXekEjwhK+sGz\r\n6gXbhIpArEFzCoKEhOHpfbVWrNghjlQXYvvDi+0mE1hyOc/N4Z5C6uluT4QMvW15\r\nJjj8cSK3A3/TSoxzVZjGttDCB1gqefDHkB7MawUginFHCqSTeocgw9FmfzelL5Jj\r\n13d+GXTmGcXijdiLSAExUrRWnsoGEhi66Kkm88s4AybtzrewvZmGNPf6ExsDMPZZ\r\nsVOTw9051zu8jFCqW7S91ZR0S32V4elMpAoCF+D5pXvJW6Hj/LNrJdm6kN5bRhRP\r\nguKUogI3rjIvi7EsmlENsx3I5pQVaGU9FC3kSIcwe0rID3l2pp0S5FzvgwlP2j+a\r\nMyD+48RVcsf37bMGRl5NvQa0/9UCJj2q9FUAkNPbzNP9fzGyjTdzpXbu37KHL/qI\r\n4WwJoj0qxoCQye7oQkXV/n791PwCT7e38BtFG8F9Tu9/4Ql5bhgZICvm4s8mlvIf\r\nqWxUi4HpOWP0NaYJwC7s3D+n9CWyLjkuENjsOo7IS11VxHevj1QLFNoaVSvwvkCJ\r\na9MQIL4ePIIyNdKSUYataRteqw==\r\n-----END ENCRYPTED PRIVATE KEY-----\r\n",
- "rpwd": "4b55fa9d4c4bf39ef10f319032b0cc764034631df3baf30d2a258c16dd3990f573765315a6407fe09769a5a17475c070",
- "icrt": "-----BEGIN CERTIFICATE-----\r\nMIIGqjCCBJKgAwIBAgIBATANBgkqhkiG9w0BAQsFADCBljELMAkGA1UEBhMCQkUx\r\nETAPBgNVBAgTCEJydXNzZWxzMREwDwYDVQQHEwhCcnVzc2VsczEZMBcGA1UEChMQ\r\nRW5naW5lZXJpbmcgVGVhbTEbMBkGA1UECxMSTW9yaW8gQ2x1c3RlciBUZXN0MSkw\r\nJwYDVQQDEyBNb3JpbyBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eTAeFw0yNDA3\r\nMzAxNTM2MDJaFw0yOTA3MzAxNTM2MDJaMIGeMQswCQYDVQQGEwJCRTERMA8GA1UE\r\nCBMIQnJ1c3NlbHMxETAPBgNVBAcTCEJydXNzZWxzMRkwFwYDVQQKExBFbmdpbmVl\r\ncmluZyBUZWFtMRswGQYDVQQLExJNb3JpbyBDbHVzdGVyIFRlc3QxMTAvBgNVBAMT\r\nKE1vcmlvIEludGVybWVkaWF0ZSBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwggIiMA0G\r\nCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDUc48Pq4lAoBmeW+3q/EuujAaUjgqD\r\nQ+nyFmuHqpVXTTW1ihtPSHl6utHonKhJShNrWHdjLwL89CwRPr/FPYuvZdkURW/f\r\nfWkbFwxq3eYv3h2DighA037a3/n6QaWq7AEkzY0dTIZv8uLotYaahzEqdFmjY7xr\r\n4YxyH0vNySIoCQXiFCcp20lYVDcBqHOV4rRQaRXgAkFS8BCmPcdnb7IWP7FAcFBE\r\nvgmrEfsov/+ODim5nQvbWcjeNRW6VhFbr7gjC1vAbyF3CTTYhoCCAqpjMx6FRGQr\r\n98sgJS8EfOPm6KGSDifnFradOTu+iwkO9gqgaL5/tsFMVmPA0Rw7j7BAL/1BIX0U\r\npUjhYCC8EkR6DjHCflg/2r/alFY1sb7ToNF/Y6EpRge01LZQYtZTSQCtAxb2VTGV\r\nqcY2HrevwVBV7xWri+4yL4hO3g7iXhKICof73hxvzx9GzcKxji8Vx3myBF+GPHs1\r\nrjVu/NoNGnBRjtNFtMBqVWF0njjJEGctdOtjg5gQtwwdZ2HUi4AYLZwxUC2zuSNk\r\njbSAIRVby3kRds3IvWP5rA23W2ZqisFNV9JAisMp8BTOcU60U9G1LDd6aFmy4HW8\r\nxhYSZPT/FwjkOpCGkxfhj9j/Isryk6EkPjKFmAQco/SsowsTx++i0jYDakAC3kAY\r\nW9iUe9TVyUDHvwIDAQABo4H4MIH1MAwGA1UdEwQFMAMBAf8wCwYDVR0PBAQDAgL0\r\nMDsGA1UdJQQ0MDIGCCsGAQUFBwMBBggrBgEFBQcDAgYIKwYBBQUHAwMGCCsGAQUF\r\nBwMEBggrBgEFBQcDCDARBglghkgBhvhCAQEEBAMCAPcwHQYDVR0OBBYEFBXTulyT\r\nviUbrrlAuwx/niHWXiRwMGkGA1UdEQRiMGCCHnBvYy1tb3Jpby1ub2RlMS5jZXJ0\r\nLmV1cm9wYS5ldYIecG9jLW1vcmlvLW5vZGUyLmNlcnQuZXVyb3BhLmV1gh5wb2Mt\r\nbW9yaW8tbm9kZTMuY2VydC5ldXJvcGEuZXUwDQYJKoZIhvcNAQELBQADggIBAJ0T\r\nppMmOhBjhcpdXaPnCqtl7Ey5g8GLQ7dzQzo/vtbcK20XSDP7mvFnIGSiPhXOpsKo\r\nmpbVJeueZ74MhWD7FFdaOEaiOASJS6RSqFfb1fmNDsYECX0nd3dNPzhDl0/m71ds\r\nVkuG1pZk5zuErTUjIT3WH38ihDQ/Da3pNUHk/O2gfhPmVRroyF9U1vK9nd7ODzyD\r\nXaAuXLual640Mq/QQhEU9a726MrErr1S6ij7OvE8EU4OrI5JumullNTSFNn/SVvA\r\nuMoeHup4OmkWQz2hWvihdW14IGCyLiHwHZXc1f5ade0Qn0xIlECbh2bKBpYRzn2g\r\nVLnJSu5NslLVA2++Bc9N7TsCcEDRw89JBsEGKM0IE5rUeh0M6FzXB7LDVZDNLvlw\r\nJDboMCtUNRNqsuFk9YDZnhW6T3E4vmCF6mzNt2b+2roHg7xMF86rVFtutgIewPSc\r\n5855KJAdHTJkbklsNZvpyenhNMkMhvQEyfL11OxYjDK9VDe8JKnT926URYH+9F0R\r\nY6NAXcyHMIO/+MytvjEc4GXsMqzx31z/PejchyEYwjFzzCeN5RagalKY/TfRsnOg\r\nKwMLfZI84LssJMtT28DQYejidQhVxzW8HOhPTIfDviCFMdbLXDpv0IDTbFbGyy5x\r\nAYmhojzVAVD8Mu97ZfQJzf7Gl44QDAyrwfhF8SpD\r\n-----END CERTIFICATE-----\r\n",
- "ikey": "-----BEGIN ENCRYPTED PRIVATE KEY-----\r\nMIIJnzBJBgkqhkiG9w0BBQ0wPDAbBgkqhkiG9w0BBQwwDgQISg9sMKGq9tQCAggA\r\nMB0GCWCGSAFlAwQBAgQQaoEn3gagMi428upX5hy5UwSCCVADdfIbat12Jt2va341\r\nmEqT7BK8xLpOcCb45hXxcdhav9vfxIAf1DOpxDUH8iTbM0+QQ2Ue1tJrSr1R/4a9\r\nnk4bQDMhQw/pW7fEG6WKfRKzwFkFq5G1vW7RmW5XVY2PdJ+3arPLffLG+0NbL/9d\r\n7nkEUlVW0WknyfDXAhwTpGMrdrcQGypSrLna/vfxqLC70v25QgM36yUokibD5d3O\r\nOQ1SL0mK+Een7nCEIYTwjD4/Pt8BMeITthd74CKCl97tPTwM+6cnV5GMQEYQ366d\r\nmwg3V9GgxVjEoRMGAL+FqKnqjtPp7sXBHDI8DB2JFHRWhu+l6kiMYWGKFrlX9tWW\r\nAr4SFwxrQDz7u8oy5wCVCgk9rjPMZjvmv0Ojb95/2SNds3Jrq2BYkd9Y6BQsEGlv\r\n50miHJpkSsUPJiV50Tb66h7LtgHZXjBT/SJUyXros1ezKyCnor1RWgFh2/IMLTi4\r\nbGELIJjVRhx3y4rCRBLIpUWWYOBXEm9o4llberpF4fOxZnGgn3ZhNttHTLXhKJH3\r\n3S9fInLiogeq9d94/Vc24Qeu7uMODQHBn7soXoL4o2vCkL4i5rLpGtaYO7DG/Zir\r\nbx3NLmKB4ys23iKvX9lPDWacaenXp7bMfzxnS4cdrApYkey73S+ruvXXAkCgdFYv\r\n1G+xUGfaWq789eu60h2o6kFJazrHQe3x2N3EvsR3Hbc8NALOZaGfHUotYDOsHbGH\r\n46c1wR1ns3QzsgrA2mraZwLOVHUYvwJnUNhw3FjpKuVU73NM61fF+18igmtrPA2C\r\nDXV4brg18t5+l5PQbNwmnB+jAQtVZ/JAacN9Vg8lzUjIts8BngAF+cmNjr7BTwVu\r\nnE4ZciqKj0wgR+XYlnnD38pav6qmlKuS9zvU/hLj35lcQYBaQT17P4CFjU74g/0f\r\n1kfm+828rL681g/8oHwMTZGKbyasZEMd1iXkF2u/uHzbJoM5fb+vViNMhqEGw3VL\r\nKD8gCeA19xwk8/jP7Q2njnGBk+wF5b7W+WgjG0wVMX7ZfRKIVjS/O4l3V7eEhvpQ\r\nCZlZIN3t6UaqUjqfTrV0SqbcdF1WRE7QeM3iLxq36zeOquMdv3P0vWAxx1YpAA0z\r\n49u/IhRSuuyOPVFeL2AZhTc1bHi+/Jxqeon/Rw2y/DjwwsOt79gFWvL66JGVtj6a\r\nB17Ak6XlzXfArKBzETXZZn+VcRbxonlkHpwFt9cnG4wfudzOPEHSosv8njXqKE5o\r\ny20+6dDpYs7NW+wo3B5Q/XIYPhsAoUMrB93SpU0evsC4Ue77LUzu1AA7KtH+eQDo\r\n59f+m7Domf1n8m/h1Ur/8OEgNmBweEFvaMREHfYWej8dGilwgWGcen9g6uxgcANK\r\nRXnVUdDBNnMM80XEtt9iH7x89mMV9dd0+1yvH263+6i9Yu5aGVcCtCSkB/KXlDo0\r\nS1EKF3xlBr8ejJD3f0dhdJz1x5tidpPR/rQzXp2ezVE+9bTPopNHseNZe4Jjw4Rb\r\nXm8shX7FZT+ZnPo3tsSw2MAXdMxrNjQhfxjQnV5eUomA6d7amfReQtJoaK/vWyQR\r\nIXIyfsieH9w60eUSQsGCVy5Prdvhg0kFZ56fyri6mr6QVu5ZyLKNtxfMi4m+Ubc6\r\nygmEdFu2EnIfGATWILwUQFxx2/JwRLLRV0zBzM6alHxttu6d6ciJjlcNCLr6IhW5\r\nxtHbUPCAHoLFKkFT5NO9h3miMj8blJIufzkj8ns6VnBiHimirLUtXIjLAstwKH4o\r\nMq8CoQfea6C/r/6w5UlLGXem9L6cPF6MHNuxSULMpz0XJ4yID1Gpm0eCnr6Bgoid\r\n2ElJZrfMOLXyXyJXqYTIm/PGkFNARRRoDlAH1Av6rT595tKtm4guN4M2aS0xP0Oh\r\nstrtAdyZ21Us3YYKOw1LdqgFJxF/sXJmzeGWrT+tb4asTD4EKq0ihNBeyEOlPHjP\r\nVyklMK0Zpkaxo+tn7dkM6ayWPj1FwlRUca9depPmeFLkPDnljKBhKdjRB3W0okCu\r\nWO+nc+aP9reSvMcgmWMdTuCu3W1cea2K3Nl/bNqMgMlTQWvghAXmZz5ojYYxwzUq\r\n40ENVVLaUY485PBLry6J6sX0HtWnxgVI5oQECtZ1sFPIokZFHdkpRfS9+luCwXw8\r\nFJkkrAl0xKyv+zGj3MPqUS4T0E0Cr/Dm3E/R/PGKvuxfyr/wV2bZKF9tAuC8ML6d\r\nn5+Cl+3AZ/ZdzfgzbaBoYCmH0qPiaDTOr+1765u86khRPJVg8ZBXOQ4ojqGFF2gk\r\nlQXwFlw2TRxU0luXSvOC/xusBGAHPOHX90ZsFEXv1tgncFoBrTlLFIeVBVTFO+0K\r\n4TCoPbnlVjVhSmc0sZIbzcIW+Kh96k9HqjXwVb/TzrrXS7VPD9lZ3mUC/90ungm0\r\ncjWfvcIlGk3gfGv1/zCH0RCjQmsCh2Q2VE0rWpXWTTcEo824CPMpJtqiOcurosJG\r\n+PRfMqeLjqOPwNpVBXuFOaXdQqPqDbZe2rSMkyBsiGGdxH6/8brrLJ8YNuanxRsU\r\nujfQtVA3qsgBF+IHXjvMeCA3yMWKYBePn9AtzyDaZDJy1QKj9KH5U8icX2PE79La\r\nLH218dlIalJxByiDqIKYSZcwnthB2C/l/YhUEeHmfHOVpzAycO4S4q3IkImNEqXq\r\nyL4izHq2Va3iPBgn4aKmPNX6oScC3X5WEsvuWOtKri4ySKXZSRFExbgSyyb705iI\r\nb9Poz+UnhBYdOPYZ5GNruTOwZGAjimCg/zbDoCbVDAuNlxVqcRKtvIMNC+HsHJ3n\r\nk2gfpygtH+qFS1OZOEnfRri34x7lgMOkISHWKncicnvxAZd+ZfJRAo2Ej1QOIyAk\r\nixF/jDvCmhckJsB7Mzs9s8pv0uak+I5+lHpcq9Q5xh7eXcS5hHSIjOV3p7G5lICS\r\n/FXq8mA/6elm+kVkj9mXCIMWSeUNV6Wfs9WISzuuHTW9CbIlI6001CrYAT15o/J3\r\nyvz1SyB9znfiIq7BAmyPQgq+CMTxGljCOePg4cJj1w8y8o/8C7K262h8LHnuU8vZ\r\nSVqeQhliL1u5XO8U1NyRkn9aNJgaC9J3MFWxV4Qz21zkoqbjGCK9YeannEz8l2xt\r\nI5jrVQktoHRn6ynkGB9J9zrjAeUUDqI7DhvX+8kp7pxCOwc+7AYy97nEVXswF/2p\r\nLpyuHO417iZX4JAl1dR4klVLGA==\r\n-----END ENCRYPTED PRIVATE KEY-----\r\n"
}
}, - "keys": { }
}
Response samples
- 400
{- "status": 400,
- "title": "This request violates the data schema",
- "detail": "The request data failed validation against the Morio data schema. This means the request is invalid."
}
Cluster hearbeat
This is the cluster heartbeat endpoint, which is where follower nodes will contact the leader node in a Morio cluster
Request Body schema: application/jsonrequired
The API key settings
object | |
checksum required | string |
Responses
Request samples
- Payload
{- "data": {
- "from": {
- "fqdn": "morio-node2.tokyo.morio.it",
- "serial": 2,
- "uuid": "39a47fb4-ec89-44ef-8080-9aa20b4872ed"
}, - "to": "morio-node1.tokyo.morio.it",
- "cluster": "3dafca38-993c-4ebf-8613-2d044e1450f4",
- "cluster_leader": {
- "serial": 1
}, - "version": "0.2.0",
- "settings_serial": 1722353755056,
- "status": {
- "cluster": {
- "code": 2,
- "color": "amber",
- "time": 1722353803197,
- "updated": 1722353833254
}, - "nodes": {
- "morio-node2.tokyo.morio.it": {
- "db": 0,
- "console": 0,
- "api": 0,
- "ca": 0,
- "proxy": 0,
- "ui": 0,
- "broker": 0
}, - "morio-node1.tokyo.morio.it": {
- "db": 0,
- "console": 0,
- "api": 0,
- "ca": 0,
- "proxy": 0,
- "ui": 0,
- "broker": 0
}, - "morio-node3.tokyo.morio.it": {
- "db": 0,
- "console": 0,
- "api": 0,
- "ca": 0,
- "proxy": 0,
- "ui": 0,
- "broker": 0
}
}
}, - "nodes": {
- "39a47fb4-ec89-44ef-8080-9aa20b4872ed": {
- "fqdn": "morio-node2.tokyo.morio.it",
- "hostname": "morio-node2",
- "serial": 2,
- "uuid": "39a47fb4-ec89-44ef-8080-9aa20b4872ed",
- "settings": 1722353755056
}, - "cc048048-798b-4d13-97a0-200874b281f6": {
- "fqdn": "morio-node3.tokyo.morio.it",
- "hostname": "morio-node3",
- "serial": 3,
- "uuid": "cc048048-798b-4d13-97a0-200874b281f6",
- "settings": 1722353755056
}, - "e6d275ab-6285-4986-a0f9-81cb12d2ce4b": {
- "fqdn": "morio-node1.tokyo.morio.it",
- "hostname": "morio-node1",
- "serial": 1,
- "uuid": "e6d275ab-6285-4986-a0f9-81cb12d2ce4b",
- "settings": 1722353755056
}
}, - "broadcast": false,
- "uptime": 105
}, - "checksum": "fcbad2602bb511502d3665ba32c3e3aaa6fe552487d18d25c4ef32c2d2e16c95"
}
Response samples
- 400
{- "status": 400,
- "title": "This request violates the data schema",
- "detail": "The request data failed validation against the Morio data schema. This means the request is invalid."
}
Generate X.509 certificate
Generates an X.509 certificate, issued by Morio's internal Certificate Authority
Request Body schema: application/jsonrequired
The Morio settings you want to validate
object | |||||||||||||||
|
Responses
Request samples
- Payload
{- "certificate": {
- "cn": "A Morio Certificate",
- "c": "BE",
- "st": "Brussels",
- "l": "Brussels",
- "o": "CertsRus",
- "ou": "NotThatCrypto",
- "san": [
- "morio-name1.brussels.morio.it",
- "morio-name2.brussels.morio.it",
- "morio-name3.brussels.morio.it"
]
}
}
Response samples
- 400
{- "status": 400,
- "title": "This request violates the data schema",
- "detail": "The request data failed validation against the Morio data schema. This means the request is invalid."
}
Decrypt data
Decrypts data with Morio's internal key pair
Request Body schema: application/jsonrequired
The data you want to decrypt
iv required | string |
ct required | string |
Responses
Request samples
- Payload
{- "iv": "f098ed647cae1e2ddfc53240c786c3ab",
- "ct": "43a24de68ca4e8625692e3b3dc8e586d5e146531d49a70c727bac838d57bcda0"
}
Response samples
- 400
{- "status": 400,
- "title": "This request violates the data schema",
- "detail": "The request data failed validation against the Morio data schema. This means the request is invalid."
}
Encrypt data
Encrypts data with Morio's internal key pair
Request Body schema: application/jsonrequired
The data you want to encrypt
data required | string |
Responses
Request samples
- Payload
{- "data": "This is secret"
}
Response samples
- 400
{- "status": 400,
- "title": "This request violates the data schema",
- "detail": "The request data failed validation against the Morio data schema. This means the request is invalid."
}
List containers
This is a proxy endpoint for the Docker API on the host system that returns list of all containers available on the host system.
To only get the running containers, use the /docker/containers
endpoint instead.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
List running containers
This is a proxy endpoint for the Docker API on the host system that returns the list of containers currently running on the hoste sytem.
To get all containers, use the /docker/allcontainers
endpoint instead.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Get storage metrics
This is a proxy endpoint for the Docker API on the host system that returns information on the used and available storage on the host sytem.
This endpoint is named after the the df
command on Linux.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
List images
This is a proxy endpoint for the Docker API on the host system that returns the list of Docker images available on the host system.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Get Docker info
This is a proxy endpoint for the Docker API on the host system that returns general information about the Docker daemon on the host system.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
List networks
This is a proxy endpoint for the Docker API on the host system that returns a list of Docker networks on the host system.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Get Docker version
This is a proxy endpoint for the Docker API on the host system that returns information on the version of Docker that is running on the host system.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Inspect container
This is a proxy endpoint for the Docker API on the host system that returns information on the container with the ID passed as a parameter in the URL.
This endpoint is equivalent to running the inspect
command on a container in the Docker CLI.
Note that Docker accepts an ID or (unambigious) name as input.
path Parameters
id | string The ID (or name) of the relevant docker object |
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Get logs
This is a proxy endpoint for the Docker API on the host system that returns logs from the container with the ID passed as a parameter in the URL.
This endpoint is equivalent to running the logs
command on a container in the Docker CLI.
Note that Docker accepts an ID or (unambigious) name as input.
path Parameters
id | string The ID (or name) of the relevant docker object |
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Get usage stats
This is a proxy endpoint for the Docker API on the host system that returns stats based on resource usage from the container with the ID passed as a parameter in the URL.
These stats come from a container'se inspect
command in the Docker CLI.
Note that Docker accepts an ID or (unambigious) name as input.
path Parameters
id | string The ID (or name) of the relevant docker object |
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Inspect image
This is a proxy endpoint for the Docker API on the host system that returns information on the image with the ID passed as a parameter in the URL.
This endpoint is equivalent to running the inspect
command on an image in the Docker CLI.
Note that Docker accepts an ID or (unambigious) name as input.
path Parameters
id | string The ID (or name) of the relevant docker object |
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Inspect network
This is a proxy endpoint for the Docker API on the host system that returns information on the network with the ID passed as a parameter in the URL.
This endpoint is equivalent to running the inspect
command on a network in the Docker CLI.
Note that Docker accepts an ID or (unambigious) name as input.
path Parameters
id | string The ID (or name) of the relevant docker object |
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Kill container
This changes, or attempts to change, the container state by issuing a kill
command.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Pause container
This changes, or attempts to change, the container state by issuing a pause
command.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Restart container
This changes, or attempts to change, the container state by issuing a restart
command.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Start container
This changes, or attempts to change, the container state by issuing a start
command.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Stop container
This changes, or attempts to change, the container state by issuing a stop
command.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Unpause container
This changes, or attempts to change, the container state by issuing a unpause
command.
Responses
Response samples
- 409
{- "status": 409,
- "title": "Not available in ephemeral mode",
- "detail": "This endpoint is not available when Morio is running in ephemeral mode. Since this system has not yet been set up, this endpoint is not yet available."
}
Build a .deb package
This will trigger the build of a .deb client package.
Note that this will start an ephemeral container to start the build. This API endpoint will not wait for the build to complete before retuning.
Request Body schema: application/jsonrequired
The configuration for building the .deb
client package
Package required | string |
Source required | string |
Section required | string Value: "utils" |
Priority required | string Value: "required,important,standard,optional,extra" |
Architecture required | string |
Essential required | string Value: "no" |
Depends required | Array of any |
Installed-Size required | number <float> |
Maintainer required | string |
Changed-By required | string |
Uploaders required | Array of any |
Homepage required | string |
Description required | string |
DetailedDescription required | string |
Vcs-Git required | string |
Version required | string |
Revision required | number <float> |
Responses
Request samples
- Payload
{- "Package": "morio-client",
- "Source": "morio-client",
- "Section": "utils",
- "Priority": "optional",
- "Architecture": "amd64",
- "Essential": "no",
- "Depends": [
- [
- "auditbeat",
- ">= 8.12"
], - [
- "filebeat",
- ">= 8.12"
], - [
- "metricbeat",
- ">= 8.12"
]
], - "Installed-Size": 5000,
- "Maintainer": "CERT-EU <services@cert.europa.eu>",
- "Changed-By": "Joost De Cock <joost.decock@cert.europa.eu>",
- "Uploaders": [
- "Joost De Cock <joost.decock@cert.europa.eu>"
], - "Description": "The Morio client collects and ships observability data to a Morio instance.",
- "DetailedDescription": "Deploy this Morio client (based on Elastic Beats) on your endpoints,\nand collect their data on one or more centralized Morio instances\nfor analysis, further processing, downstream routing & filtering,\nor event-driven automation.",
- "Vcs-Git": "https://github.com/certeu/morio -b main [clients/linux]",
- "Version": "0.2.0",
- "Revision": 1
}
Response samples
- 400
{- "status": 400,
- "title": "This request violates the data schema",
- "detail": "The request data failed validation against the Morio data schema. This means the request is invalid."
}
Get .deb package defaults
This will return the default values to create a new .deb client package.
Note that configuration of a .deb
package needs to be correct or the package will not function.
You can adapt these defaults (that's why we provide them), but should consult the Debian documnentation on packaging.
Responses
Apply settings
This will take a full set of new Morio settings and, after validation, apply them.
Note that this endpoint requires you to post the full settings, so when making updates, make sure to leave nothing behind.
Request Body schema: application/jsonrequired
The new Morio settings
object | |
object | |
connector | object |
object | |
object | |
object | |
object or string | |
object |
Responses
Request samples
- Payload
{- "name": "Morio Standalone Example",
- "broker_nodes": [
- "morio-node1.tokyo.morio.it"
], - "flags": {
- "HEADLESS_MORIO": false,
- "DISABLE_ROOT_TOKEN": false
}, - "secrets": {
- "AD_PASSWORD": "aa;S009)) _S asd0AS"
}, - "providers": {
- "apikey": {
- "provider": "apikey",
- "id": "apikey",
- "label": "API Key"
}, - "mrt": { },
- "local": {
- "provider": "local",
- "id": "local",
- "label": "Morio Account"
}, - "ad": {
- "provider": "ldap",
- "id": "ad",
- "about": "Morio Tokyo branch on-prem Active Directory",
- "server": {
- "url": "ldaps://dc1.tokyo.morio.it",
- "bindDN": "CN=morio-ldap,OU=Users,DC=tokyo,DC=morio,DC=it",
- "bindCredentials": "{{{ AD_PASSWORD }}}",
- "searchBase": "OU=Users-EU,DC=tokyo,DC=morio,DC=it",
- "searchFilter": "(&(objectClass=user)(samaccountname={{username}}))"
}, - "username_field": "samaccountname",
- "label": "Active Directory",
- "rbac": {
- "user": {
- "attribute": "samaccountname",
- "regex": "."
}, - "root": {
- "attribute": "samaccountname",
- "regex": "^(?:joostdecock|sorchanidhubhghaill)$"
}
}, - "verify_certificate": true
}
}, - "visibility": {
- "mrt": "icon",
- "local": "icon",
- "apikey": "icon"
}, - "order": [
- "ad",
- "local",
- "apikey",
- "mrt"
]
}
Response samples
- 400
{- "status": 400,
- "title": "This request violates the data schema",
- "detail": "The request data failed validation against the Morio data schema. This means the request is invalid."
}
Set up Morio
This will set up Morio with the provided initial settings.
This endpoint is only available in ephemeral Mode. In other words, once Morio is set up, this endpoint becomes unavailable.
Request Body schema: application/jsonrequired
The Morio settings to use for the intial setup
object | |
object | |
connector | object |
object | |
object | |
object | |
object or string | |
object |
Responses
Request samples
- Payload
{- "name": "Morio Standalone Example",
- "broker_nodes": [
- "morio-node1.tokyo.morio.it"
], - "flags": {
- "HEADLESS_MORIO": false,
- "DISABLE_ROOT_TOKEN": false
}, - "secrets": {
- "AD_PASSWORD": "aa;S009)) _S asd0AS"
}, - "providers": {
- "apikey": {
- "provider": "apikey",
- "id": "apikey",
- "label": "API Key"
}, - "mrt": { },
- "local": {
- "provider": "local",
- "id": "local",
- "label": "Morio Account"
}, - "ad": {
- "provider": "ldap",
- "id": "ad",
- "about": "Morio Tokyo branch on-prem Active Directory",
- "server": {
- "url": "ldaps://dc1.tokyo.morio.it",
- "bindDN": "CN=morio-ldap,OU=Users,DC=tokyo,DC=morio,DC=it",
- "bindCredentials": "{{{ AD_PASSWORD }}}",
- "searchBase": "OU=Users-EU,DC=tokyo,DC=morio,DC=it",
- "searchFilter": "(&(objectClass=user)(samaccountname={{username}}))"
}, - "username_field": "samaccountname",
- "label": "Active Directory",
- "rbac": {
- "user": {
- "attribute": "samaccountname",
- "regex": "."
}, - "root": {
- "attribute": "samaccountname",
- "regex": "^(?:joostdecock|sorchanidhubhghaill)$"
}
}, - "verify_certificate": true
}
}, - "visibility": {
- "mrt": "icon",
- "local": "icon",
- "apikey": "icon"
}, - "order": [
- "ad",
- "local",
- "apikey",
- "mrt"
]
}
Response samples
- 400
- 409
{- "status": 400,
- "title": "This request violates the data schema",
- "detail": "The request data failed validation against the Morio data schema. This means the request is invalid."
}
Preseed Morio
This will set up Morio with the provided preseed settings.
This endpoint is only available in ephemeral Mode. In other words, once Morio is set up, this endpoint becomes unavailable.
Request Body schema: application/jsonrequired
The Morio preseed settings to use for the intial setup
url | string |
git | object |
object or object or object or string | |
(Array of objects or objects or objects or strings) or string | |
object |
Responses
Request samples
- Payload
{- "github": {
- "owner": "morio",
- "repo": "preseed",
- "file_path": "settings/standalone.yaml",
- "ref": "main",
- "token": "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"
}
}
Response samples
- 400
- 409
{- "status": 400,
- "title": "This request violates the data schema",
- "detail": "The request data failed validation against the Morio data schema. This means the request is invalid."
}