URI |
Method |
Auth |
|
/token |
POST |
Yes |
Get Token against the Username and Password in the configuration file. Response should be a valid token when the credentials match.  Return code 201 Created with valid token
 Invalid credentials, return code 401 Unauthorized
Invalid request, return code 400 Bad request |
/tpm/{node-name} |
POST |
Yes |
Get Token against the Username and Password in the configuration file OR TPM SHA256 ID. Response should be a valid token when the credentials match. Return code 200 |
/filesauth |
GET |
Yes |
Get a success message on the behalf of the Token provided. Return code 200 |
/version |
GET |
No |
Return LUNA and API version Return code 200 OK |
/all-routes |
GET |
No |
Get the current version of Luna. Return code 200 |
/boot |
GET |
No |
Get boot menu (see templ_boot_ipxe.cfg) Send code 200 with the written out template Send code 503 if backend is unavailable. |
/boot/short |
GET |
No |
Same as boot, but using short (see templ_boot_ipxe_short.cfg) Send code 200 with the written out template Send code 503 if backend is unavailable. |
/boot/disk |
GET |
No |
Same as boot, but using disk (see templ_boot_disk.cfg) Send code 200 with the written out template Send code 503 if backend is unavailable. |
/boot/search/mac/{mac-address} |
GET |
No |
Discovery on MAC address, Server will lookup the MAC if SNMP port-detection has been enabled. See #Design Return code 200 with hostname if it exists  Return 404 if no result
Return 503 if backend is unavailable |
/boot/manual/group/{group-name}/{mac-address} |
GET |
No |
Manual setting the group name and booting from the entry Return code 200 with hostname if it exists Return 404 if no result Return 503 if backend is unavailable |
/boot/manual/hostname/{hostname}/{mac-address} |
GET |
No |
Manual setting the hostname and booting from the entry Return code 200 with hostname if it exists Return 404 if no result Return 503 if backend is unavailable |
/boot/install/{node} |
GET |
No * Auth by IP |
Call the installation script for this node. Return code 200 with the installation script Return 404 if node can not be found Return 503 if backend is unavailable |
/config/node |
GET |
Yes |
Produce a list of all nodes Return code 200 if ok Return code 401 if no valid token is supplied |
/config/node/{node} |
GET |
Yes |
Shows node host information Return code 200 with node data if OK Return code 401 if no valid token is supplied Return code 404 if it doesn’t exist |
/config/node/{node} |
POST |
Yes |
Create or update node. Return code 204 if any field has been updated Return code 201 if new node is created or hostname is updated Return code 401 if no valid token is supplied |
/config/node/{node}/_clone |
POST |
Yes |
Clone node. Return code 204 if any field has been updated Return code 201 if new node is created or hostname is updated Return code 401 if no valid token is supplied |
/config/node/{node}/_delete |
GET |
Yes |
Remove entry Return 204 No Content if OK Return code 404 if the entry doesn’t exist. Return code 401 if no valid token is supplied |
/config/node/{node}/_osgrab |
POST |
yes |
grabs running/live O/S from node and merges this into its defined image. return 200 on success with request_id for rolling status Return code 401 if no valid token is supplied Return code 404 if the entry doesn’t exist. |
/config/node/{node}/_ospush |
POST |
yes |
sends content of the image to the node, merges with live filesystem return 200 on success with request_id for rolling status Return code 401 if no valid token is supplied Return code 404 if the entry doesn’t exist. |
/config/node/{node}/interfaces |
GET |
Yes |
List the network interfaces of the individual node. Return code 200 if OK Return code 404 if it doesn’t exist. |
/config/node/{node}/interfaces |
POST |
Yes |
Updates the interface array for one specific node Return code 204 when created or updated interface Return code 404 if the node doesn’t exist. Return code 401 if no valid token is supplied  Note that this overrides the group
|
/config/node/{node}/interfaces/{interface} |
GET |
Yes |
Get interface information. Updating the information is done by passing the array to the interfaces endpoint of the group. Return code 200 if OK Return code 401 if no valid token is supplied Return code 404 if it doesn’t exist |
/config/node/{node}/interfaces/{interface}/_delete |
GET |
Yes |
Delete specific interface from the node Return 204 if OK Return code 404 if it doesn’t exist Return code 401 if no valid token is supplied |
/config/group |
GET |
Yes |
Produce a list of groups Return code 200 with the list of groups Return code 401 if no valid token is supplied |
/config/group/{group} |
GET |
Yes |
Show group information Return code 200 if OK Return code 401 if no valid token is supplied Return code 404 if it doesn’t exist |
/config/group/{group} |
POST |
Yes |
Create or update group. Return code 204 if any field has been updated Return code 201 if new group is created Return code 401 if no valid token is supplied |
/config/group/{group}/_delete |
GET |
Yes |
Remove entry Return 204 No Content if OK Return code 404 if it doesn’t exist Return code 401 if no valid token is supplied |
/config/group/{group}/_ospush |
POST |
yes |
equal to _ospush for one node, but in this case to all node members of the group return 200 on success with request_id for rolling status Return code 401 if no valid token is supplied Return code 404 if the entry doesn’t exist. |
/config/group/{group}/interfaces |
GET |
Yes |
List the network interfaces of the individual group. Return code 200 with group interface data Return code 401 if no valid token is supplied Return code 404 if group doesn’t exist |
/config/group/{group}/interfaces |
POST |
Yes |
Create or update the network interface. Primary is the interface name. Note reserved names such as BOOTIF and BMC Return code 204 when updating or creating interfaces Return code 404 if the group doesn’t exist Return code 401 if no valid token is supplied |
/config/group/{group}/interfaces/{interface} |
GET |
Yes |
Get interface information. Updating the information is done by passing the array to the interfaces endpoint of the group. Return code 200 if OK Return code 401 if no valid token is supplied Return code 404 if it doesn’t exist Return code 503 if backend is unavailable |
/config/group/{group}/interfaces/{interface}/_delete |
GET |
Yes |
Remove entry (single interface) Return 204 No Content if OK Return code 404 if it doesn’t exist Return code 401 if no valid token is supplied |
/config/osimage |
GET |
Yes |
Get a list of osimages Return code 200 if OK Return code 401 if no valid token is supplied |
/config/osimage |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/config/osimage/{name} |
GET |
Yes |
Show OS image information Return code 200 if OK Return code 401 if no valid token is supplied Return code 404 if entry doesn’t exist |
/config/osimage/{name} |
POST |
Yes |
Create or update a new image (creation does not create files just the object; see _clone). Note that the kernel version can be changed in this endpoint, but it will not trigger a pack. See kernel endpoint Return code 201 when created a new image is created Return code 204 when updating fields Return code 401 if no valid token is supplied Return code 404 if entry doesn’t exist |
/config/osimage/{name}/_delete |
GET |
Yes |
Remove entry Return 204 No Content if OK Return code 404 if object doesn’t exist Return code 401 if no valid token is supplied |
/config/osimage/{name}/_delete |
POST |
Unsupported |
Not supported, return code 405 Bad request |
/config/osimage/{name}/_clone |
GET |
Unsupported |
Not supported, return code 405 Bad request |
/config/osimage/{name}/_clone |
POST |
Yes |
Clone image (creates image but also copies files from the original). Requires the newosimage field to be set Return 201 Created if OK Return code 404 if the newosimage field is not set |
/config/osimage/{name}/_pack |
GET |
Yes |
Manually pack osimage Return code 200 when executed with request_id for rolling status Return code 404 if image doesn’t exist Return code 401 if no valid token is supplied |
/config/osimage/{name}/_pack |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/config/osimage/{name}/kernel |
GET |
Unsupported |
Showing object information can be done from the /config/osimage/{name} endpoint. Not supported, return code 405 Bad Request |
/config/osimage/{name}/kernel |
POST |
Yes |
Manually change kernel version, also triggers a pack. Return code 200 when executed with request_id for rolling status Return code 204 when executed but no pack requested (bare) Return code 401 if no valid token is supplied Return code 404 if image does not exist |
/config/cluster |
GET |
Yes |
Show cluster information Return code 200 OK with cluster data Return code 401 if no valid token is supplied  Configuration of the daemons are done via the luna2.ini config file
|
/config/cluster |
POST |
Yes |
Not all configuration settings are configurable, many are read-only and provided for scripting purposes etc. Return code 204 on update or change Return code 401 if no valid token is supplied Configuration of the daemons are done via the luna2.ini config file |
/config/bmcsetup |
GET |
Yes |
Produce list of configured settings. Return code 200 and return bmc setup data Return code 401 Unauthorized when the token is missing or invalid |
/config/bmcsetup |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/config/bmcsetup/{bmcname} |
GET |
Yes |
Show BMC setup Return code 200 with bmc setup data Return code 401 Unauthorized when the token is missing or invalid Return code 404 if bmcname does not exist |
/config/bmcsetup/{bmcname} |
POST |
Yes |
Create or update BMC setup (this endpoint renames the item, to clone it, see _clone) Return code 201 when created new BMC setup Return code 204 when updating fields Return code 401 Unauthorized when the token is missing or invalid Return code 404 if bmcname does not exist |
/config/bmcsetup/{bmcname}/_clone |
GET |
Unsupported |
Not supported, return code 405 Bad Request |
/config/bmcsetup/{bmcname}/_clone |
POST |
Yes |
Used to clone an object. Return code 201 when created new BMC setup Return code 401 Unauthorized when the token is missing or invalid Return code 404 if bmcname does not exist |
/config/bmcsetup/{bmcname}/_delete |
GET |
Yes |
Remove entry, Return code 204 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if the entry doesn’t exist. |
/config/bmcsetup/{bmcname}/_delete |
POST |
Unsupported |
Not supported, return code 400 Bad Request |
/config/network |
GET |
Yes |
List networks Return code 200 OK Return code 401 Unauthorized when the token is missing or invalid |
/config/network |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/config/network/{networkname} |
GET |
Yes |
Return code 200 with network config data if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if it doesn’t exist |
/config/network/{networkname} |
POST |
Yes |
Return code 201 when created new network Return code 204 when updating fields Return code 401 Unauthorized when the token is missing or invalid Return code 404 if network does not exist |
/config/network/{networkname}/_delete |
GET |
Unsupported |
Remove entry, Return code 204 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if the entry doesn’t exist. |
/config/network/{networkname}/_delete |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/config/network/{networkname}/_clone |
GET |
Unsupported |
Not supported, return code 405 Bad Request |
/config/network/{networkname}/_clone |
POST |
Yes |
Return code 201 when created new network Return code 404 if network does not exist Return code 503 if backend is unavailable |
/config/network/{networkname}/{ipaddr} |
GET |
Yes |
Get IP information (free, reserved, unavailable) formally set to be done without token. now we do need the token. Return code 200 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if networkname doesn’t exist. |
/config/network/{networkname}/{ipaddr} |
POST |
Yes |
Not supported, return code 405 Bad Request |
/config/network/{networkname}/_nextfreeip |
GET |
Yes |
Post to the network the network name or range, return the first available IP formally set to be done without token. now we do need the token. Return code 200 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if networkname doesn’t exist. |
/config/network/{networkname}/_nextfreeip |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/config/secrets |
GET |
Yes |
Retrieve secrets from all nodes and groups Return code 200 when a valid token is provided and return secrets contents Return code 401 Unauthorized when the token is missing or invalid |
/config/secrets |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/config/secrets/node |
GET |
Unsupported |
Not supported, return code 404 URL not available |
/config/secrets/node |
POST |
Unsupported |
Not supported, return code 404 URL not available |
/config/secrets/node/{node} |
GET |
Yes |
Retrieve secrets for the node (incl. group) Return code 200 when a valid token is provided and return secrets contents Return code 401 Unauthorized when the token is missing or invalid Return code 404 if object does not exist |
/config/secrets/node/{node} |
POST |
Yes |
The endpoint supports an entire array to update or create. Use the config/secrets/node/{secret} to update a single item Return code 201 when secrets have been created Return code 204 when secrets has been changed Return code 401 Unauthorized when the token is missing or invalid Return code 404 if object does not exist |
/config/secrets/node/{node}/{secret} |
GET |
Yes |
Retrieve secret for the node Return code 200 when a valid token is provided and return secret contents Return code 401 Unauthorized when the token is missing or invalid Return code 404 if object does not exist |
/config/secrets/node/{node}/{secret} |
POST |
Yes |
Update secret for the node Return code 204 when a valid token is provided and update or create single item Return code 401 Unauthorized when the token is missing or invalid Return code 404 if object does not exist |
/config/secrets/node/{node}/{secret}/_delete |
GET |
Yes |
Return code 204 and delete single item Return code 401 Unauthorized when the token is missing or invalid Return code 404 if object does not exist |
/config/secrets/node/{node}/{secret}/_delete |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/config/secrets/node/{node}/{secret}/_clone |
GET |
Unsupported |
Not supported, return code 405 Bad Request |
/config/secrets/node/{node}/{secret}/_clone |
POST |
Yes |
Used to clone an object. Return code 201 when created new secret Return code 401 Unauthorized when the token is missing or invalid Return code 404 if secret does not exist |
/config/secrets/group |
GET |
Unsupported |
Not supported, return code 404 URL not available |
/config/secrets/group |
POST |
Unsupported |
Not supported, return code 404 URL not available |
/config/secrets/group/{group} |
GET |
Yes |
Return code 200 when a valid token is provided and return secrets contents Return code 401 Unauthorized when the token is missing or invalid Return code 404 if object does not exist |
/config/secrets/group/{group} |
POST |
Yes |
The endpoint supports an entire array to update or create. Use the config/secrets/group/{secret} to update a single item Return code 204 on update existing secrets Return code 201 when secrets have been created Return code 401 Unauthorized when the token is missing or invalid Return code 404 if object does not exist |
/config/secrets/group/{group}/{secret} |
GET |
Unsupported |
Not supported, return code 405 Bad Request |
/config/secrets/group/{group}/{secret} |
POST |
Yes |
Return code 204 on update existing secrets Return code 401 Unauthorized when the token is missing or invalid Return code 404 if group or secret do not exist |
/config/secrets/group/{group}/{secret}/_delete |
GET |
Unsupported |
Not supported, return code 405 Bad Request |
/config/secrets/group/{group}/{secret}/_delete |
POST |
Yes |
Return code 204 on deletion Return code 401 Unauthorized when the token is missing or invalid Return code 404 if group or secret do not exist |
/config/secrets/group/{group}/{secret}/_clone |
GET |
Unsupported |
Not supported, return code 405 Bad Request |
/config/secrets/group/{group}/{secret}/_clone |
POST |
Yes |
Used to clone an object. Return code 201 when created new secret Return code 401 Unauthorized when the token is missing or invalid Return code 404 if secret does not exist |
/config/switch |
GET |
Yes |
Return list of switches Return code 200 if OK Return code 401 Unauthorized when the token is missing or invalid |
/config/switch |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/config/switch/{switch} |
GET |
Yes |
Return switch information Return code 200 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if it doesn’t exist |
/config/switch/{switch} |
POST |
Yes |
Create or update switch Return code 201 when switch is created Return code 204 when switch is updated Return code 401 Unauthorized when the token is missing or invalid |
/config/switch/{switch}/_clone |
GET |
Unsupported |
Not supported, return code 405 Bad Request |
/config/switch/{switch}/_clone |
POST |
Yes |
Return code 201 when created Return code 401 Unauthorized when the token is missing or invalid Return code 404 if it doesn’t exist |
/config/switch/{switch}/_delete |
GET |
Yes |
Remove entry Return code 204 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if the entry doesn’t exist. |
/config/switch/{switch}/_delete |
POST |
Unsupported |
Not supported, return code 400 Bad Request |
/config/otherdev |
GET |
Yes |
Return list of other devices Return code 200 if OK Return code 401 Unauthorized when the token is missing or invalid |
/config/otherdev |
POST |
Unsupported |
Not supported, return code 400 Bad Request |
/config/otherdev/{device} |
GET |
Yes |
Return list of other devices Return code 200 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if the entry doesn’t exist. |
/config/otherdev/{device} |
POST |
Yes |
Create or update entry Return code 201 when new otherdev is created Return code 204 when otherdev is updated Return code 401 Unauthorized when the token is missing or invalid |
/config/otherdev/{device}/_clone |
GET |
Unsupported |
Not supported, return code 400 Bad Request |
/config/otherdev/{device}/_clone |
POST |
Yes |
Return code 201 when created Return code 401 Unauthorized when the token is missing or invalid Return code 404 if it doesn’t exist |
/config/otherdev/{device}/_delete |
GET |
Yes |
Remove entry Return code 204 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if the entry doesn’t exist. |
/config/otherdev/{device}/_delete |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/control/power |
GET |
Unsupported |
Not supported, return code 404 URL not available Note that the endpoint itself only supports a single hostname. |
/control/power/{hostname} |
GET |
Yes |
Return code 200 OK with status output (only for status) Return code 204 No Content when executed without errors (for all other commands) Return code 401 Unauthorized when the token is missing or invalid Return code 503 if backend is unavailable |
/control/action/power/{hostname}/_{action} |
GET |
Yes |
Return code 200 OK with the contents if {action} is status Return code 204 on success Return code 401 Unauthorized when the token is missing or invalid Return code 404 if the entry does not exist (host invalid) |
/control/action/power/_{action} |
POST |
Yes |
A hostlist is posted Note that the hostlist needs to be validated before any action will be allowed Return code 200 OK with the contents - request_id for rolling status. Return code 401 Unauthorized when the token is missing or invalid Return code 404 if the entry or entries do not exist (hostlist invalid) |
/files |
GET |
|
Serves out directory listing of *.tar.gz. *.tar.bz2 and initramfs and kernels. Return code 200 with the file list Return code 503 if there are no files at all |
/files |
POST |
|
Not supported, return code 405 Bad Request |
/files/{filename} |
GET |
Depending on extension, authentication required |
Services out single file (datastream) Return code 200 with file contents Return code 401 Unauthorized when the token is missing or invalid Return code 404 if file is not present or readable |
/files/{filename} |
POST |
|
Not supported, return code 405 Bad Request |
/service/dhcp/reload |
GET |
Yes |
Rewrite the DHCP entries and reload DHCP manually (note that this is generally automated by luna2 service control). Return code 200 with request_id for rolling status. Return code 401 Unauthorized when the token is missing or invalid |
/service/dhcp/reload |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/service/dns/reload |
GET |
Yes |
Rewrite the DNS entries and reload DNS manually (note that this is generally automated by luna2 service control) Return code 200 with request_id for rolling status. Return code 401 Unauthorized when the token is missing or invalid |
/service/dns/reload |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/service/luna2/reload
Not implemented - restart or reload daemon through O/S is safest option |
GET |
Yes |
Reload all internal templates Return code 200 with request_id for rolling status. Return code 500 if there is an error with systemd (return non-zero) |
/service/luna2/reload
|
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/monitor/service/dns |
GET |
No |
Return 200 with status in JSON Return 500 when service (systemd) is in failure Return 503 when Luna2 is in failure |
/monitor/service/dns |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/monitor/service/dhcp |
GET |
No |
Return 200 with status in JSON Return 500 when service (systemd) is in failure Return 503 when Luna2 is in failure |
/monitor/service/dhcp |
POST |
Unsupported |
Not supported, return code 405 Bad Request |
/monitor/service/luna2 |
GET |
No |
Return 200 with status in JSON Return 500 when service (systemd) is in failure Return 503 when Luna2 is in failure |
/monitor/service/luna2 |
POST |
Unsupported |
Not supported, return code 400 Bad Request |
/monitor/status/{node} |
GET |
No |
Return code 200 with node status Return code 404 when node does not exist Return 503 when Luna2 is in failure |
/monitor/status/{node} |
POST |
Yes |
Update node status (to be used within the luna2 installer) Return code 204 when updated Return code 401 Unauthorized when the token is missing or invalid Return code 404 when node does not exist Return 503 when Luna2 is in failure |
/config/osuser |
GET |
Yes |
returns a json/dict of all users on the system (O/S) Return code 200 with data contents Return code 401 Unauthorized when the token is missing or invalid |
/config/osuser/{username} |
POST |
yes |
updates or creates a O/S user. uses plugin (obol) to handle O/S calls Return code 201 on new user creation Return code 204 on user change Return code 401 Unauthorized when the token is missing or invalid Return code 404 if user does not exist |
/config/osuser/{username}/_delete |
GET |
yes |
deletes O/S user account. Return code 204 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if user does not exist |
/config/osgroup |
GET |
yes |
returns a json/dict of all groups on the system (O/S) Return code 200 with data contents Return code 401 Unauthorized when the token is missing or invalid |
/config/osgroup/{groupname} |
POST |
yes |
updates groups. create or change group on the system (O/S) Return code 201 on new group creation Return code 204 on group change Return code 401 Unauthorized when the token is missing or invalid Return code 404 if group does not exist |
/config/osgroup/{groupname}/_delete |
GET |
yes |
deletes O/S group. Return code 204 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 if group does not exist |
/ping |
GET |
no |
returns a json/dict with message: pong Return code 200 with data contents |
/ha/master/_set |
GET |
yes |
sets master. returns json with message: response Return code 200 when set master Return code 401 Unauthorized when the token is missing or invalid Return 503 when Luna2 could not set master |
/ha/master |
GET |
yes |
gets master status. Return code 200 if master Return code 401 Unauthorized when the token is missing or invalid Return code 404 if not master |
/ha/overrule/_set |
GET |
yes |
sets in-sync overrule for out of sync non-master luna2. can be used during disaster recovery. dangerous call. use with extreme caution. Return code 204 |
/journal |
POST |
yes |
insert of a journal task or list of tasks Return code 201 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 400 on invalid requests Return code 404 on failure |
/journal/{controller} |
GET |
yes |
get list of a journal tasks in json format Return code 200 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 on failure |
/journal/{controller}/_delete |
|
|
delete all journal tasks Return code 204 if OK Return code 401 Unauthorized when the token is missing or invalid Return code 404 on failure |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|