Skip to content
Equnix Metal
show

Self Service Reservations

Retrieve all reservations copied!

GET
/projects/{project_id}/self-service/reservations

Returns all reservations.

  • Parameters
  • 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

    project_id
    string  (required) in path

    Project UUID

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

Create a reservation copied!

POST
/projects/{project_id}/self-service/reservations

Creates a reservation.

  • Parameters
  • reservation
     (required) in body

    reservation to create

    {
        "start_date": "string",
        "period": {
            "properties": {
                "unit": {
                    "type": "string",
                    "enum": [
                        "monthly"
                    ]
                },
                "count": {
                    "type": "number",
                    "enum": [
                        12,
                        36
                    ]
                }
            }
        },
        "notes": "string",
        "item": [
            {
                "metro_id": "string",
                "plan_id": "string",
                "quantity": "integer",
                "amount": "number",
                "term": "string"
            }
        ]
    }
    project_id
    string  (required) in path

    Project UUID

Retrieve a reservation copied!

GET
/projects/{project_id}/self-service/reservations/{id}

Returns a reservation

  • Parameters
  • id
    string  (required) in path

    Reservation short_id

    project_id
    string  (required) in path

    Project UUID

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