Reservation CLI APIs

About XPRESSO Reservations CLI APIs

XPRESSO provides the following public CLI APIs to get, list, extend, and release for Requests, Bundle, Results, and Baseline information:

XPRESSO Reservation get

  • description: get a specific xpresso reservation info

  • mandatory arguments:

    --id:

    • description: xpresso reservation ID
    • usage: xpresso reservation get --id reservation_id

  • optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO Reservation list

  • description: get a list of xpresso reservations and related info

  • mandatory arguments: none

  • optional arguments:

    --limit:

    • description: limit the number of matching output
    • usage: xpresso reservation list --limit 10

    --also refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO Reservation extend

  • description: extend a xpresso reservation in seconds

  • mandatory arguments:

    --id:

    • description: xpresso reservation ID to extend
    • usage: xpresso reservation extend --id reservation_id --length 600 --reason "some valid reason"

    --length:

    • description: extend reservation in seconds
    • usage: xpresso reservation extend --id reservation_id --length 600 --reason "some valid reason"

    --reason:

    • description: extend reason
    • usage: xpresso reservation extend --id reservation_id --length 600 --reason "some valid reason"

  • optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO Reservation release

  • description: release a xpresso reservation

  • mandatory arguments:

    --id:

    • description: xpresso reservation ID to release
    • usage: xpresso reservation release --id reservation_id --reason "some valid reason"

    --reason:

    • description: release reason
    • usage: xpresso reservation release --id reservation_id --reason "some valid reason"

  • optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.