Skip to content
Snippets Groups Projects

Resolve "Write API documentation"

Merged Arie Peterson requested to merge 2-write-api-documentation into master
All threads resolved!
1 file
+ 11
7
Compare changes
  • Side-by-side
  • Inline
+ 11
7
@@ -29,9 +29,13 @@ Encryption keys:
@@ -29,9 +29,13 @@ Encryption keys:
``GET /encryption/keys``
``GET /encryption/keys``
List luks password slots
List luks password slots
``POST/PUT /encryption/keys/{slot-id}``
``POST /encryption/keys/``
Add/change a luks slot to a new password. {slot} corresponds to a slot id
Add a new password to a new Luks slot.
listed by ``GET /encryption/keys``.
 
Post data: ``{"password": password, "new-password": new-password}``
 
``POST /encryption/keys/{slot-id}``
 
Change a luks slot's password. {slot} corresponds to a slot id listed by ``GET
 
/encryption/keys``.
Post data: ``{"password": password, "new-password": new-password}``
Post data: ``{"password": password, "new-password": new-password}``
``DELETE /encryption/keys/{slot-id}``
``DELETE /encryption/keys/{slot-id}``
@@ -40,15 +44,15 @@ Encryption keys:
@@ -40,15 +44,15 @@ Encryption keys:
SSH keys with access to the initrd:
SSH keys with access to the initrd:
``GET /ssh/keys``
``GET /ssh/keys``
List SSH keys in the ``/root/authorized_keys`` file
List SSH keys in the ``/root/.ssh/authorized_keys`` file
``POST/ssh/keys``
``POST/ssh/keys``
Add a key to the authorized_keys file
Add a key to the ``authorized_keys`` file
Post data: ``{"ssh-key": ssh-key}``
Post data: ``{"ssh-key": ssh-key}``
``PUT /ssh/keys/{key-id}``
``PUT /ssh/keys/{key-id}``
Change a key in the authorized_keys file
Change a key in the ``authorized_keys`` file
Post data: ``{"ssh-key": ssh-key}``
Post data: ``{"ssh-key": ssh-key}``
``DELETE /ssh/keys/{key-id}``
``DELETE /ssh/keys/{key-id}``
Delete the key with id {key} from the autorized_keys file
Delete the key with id ``{key-id}`` from the ``authorized_keys`` file
Loading