API Documentation

This document describes the API offered

All parameters in this documentation are surrounded by <>.

Bootscript related API

/v1/bootscript/script.ipxe

GET Returns the bootscript for the host issuing the GET request

/v1/bootscript/script.ipxe/

GET Return the bootscript for the host with IP address POST set the bootscript for the host with IP address

Lock related API

/v1/host_lock/lock/

GET take the lock if possible and return a token in the response body. If the host is already locked, HTTP status 412 is returned.

/v1/host_lock/lock//

PUT token is retrieved when locking, this needs to be passed to the unlock. free the lock. If it is not locked, HTTP status 412 signals the error.

/v1/host_lock/lock_state/

GET retrieve the lock status of . Returned in the body as locked or unlocked

Job-ID related API

/v1/latest_job/////

GET retrieve the latest jobid from the connected openQA-instance in the request body. All variables are mandatory here. Example: v1/latest_job/x86_64/sle/Online/15-SP2/create_hdd_minimal_base+sdk On error, HTTP status 404 is returned.