show

Hardware Reservations

Hardware Reservation Management. Check out the product docs to learn more about Reserved Hardware.

Retrieve all hardware reservations for a given project

GET
/projects/{id}/hardware-reservations

Provides a collection of hardware reservations for a given project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve a hardware reservation

GET
/hardware-reservations/{id}

Returns a single hardware reservation

  • Parameters
  • id
    string  (required) in path

    HardwareReservation UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Move a hardware reservation

POST
/hardware-reservations/{id}/move

Move a hardware reservation to another project

  • Parameters
  • id
    string  (required) in path

    Hardware Reservation UUID

    project_id
     (required) in body

    Project UUID