summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorJannik Schönartz2019-03-18 18:27:55 +0100
committerJannik Schönartz2019-03-18 18:27:55 +0100
commitf486a08621eec271889c4e2108e0038a98e78946 (patch)
tree18150cd68cdcdee42a2a62ce2a124badaf6f4cbb /documentation
parent[server/log] sql JSON to TEXT for mariadb compatibility (diff)
downloadbas-f486a08621eec271889c4e2108e0038a98e78946.tar.gz
bas-f486a08621eec271889c4e2108e0038a98e78946.tar.xz
bas-f486a08621eec271889c4e2108e0038a98e78946.zip
[server/registration] Add server registration
Diffstat (limited to 'documentation')
-rw-r--r--documentation/api/collections.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/documentation/api/collections.md b/documentation/api/collections.md
index 301a0bb..b1e85b8 100644
--- a/documentation/api/collections.md
+++ b/documentation/api/collections.md
@@ -163,6 +163,50 @@ body {
## Configuratior
## Groups
## Ipxe
+## Log
## Permissions
+
+## Registration
+```json
+POST Request - unauthorized
+https://<domain_bas>/api/registration
+
+body {
+ "client": {
+ "name": "<name>",
+ "parents": [],
+ "type": "<type>",
+ "uuid": "<uuid>",
+ "purpose": "",
+ "network": {
+ "mac": "<mac>",
+ "ip": "<ip>"
+ },
+ "location": {
+ "option": "<option>",
+ "insertion": "<insertion>",
+ "pos": 0
+ },
+ "formfactor": {
+ "formfactor": "<formfactor>",
+ "rackunits": 1
+ }
+ },
+ "ipxe": false
+}
+```
+
+> **\<name\>** - Name of the client. Default: Client_uuid or Server_uuid\
+> **parentIds** - Ids of the groups the client gets added to\
+> **\<type\>** - CLIENT or SERVER\
+> **\<uuid\>** - UUID of the client\
+> **\<mac\>** - Mac address of the client\
+> **\<ip\>** - IP address of the client\
+> **\<option\>** (Server only) - Horizontal or Vertical\
+> **\<insertion\>** (Server only) - Front, Back, or Front and backside\
+> **\<formfactor\>** (Server only) - 19\"\
+> **\<rackunits\>** (Server only) - Amount of slots the server needs (int)\
+> **\<ipxe\>** - Determines weather the return value is an ipxe script or not (true / false)
+
## Roles
## Users \ No newline at end of file