show

Spot Market Request

Spot Market Requests Management. Check out the product docs to learn more about Spot Market features.

Create a spot market request

POST
/projects/{id}/spot-market-requests

Creates a new spot market request.

Type-specific options (such as operating_system for baremetal devices) should be included in the main data structure alongside hostname and plan.

The features attribute allows you to optionally specify what features your server should have. For example, if you require a server with a TPM chip, you may specify { "features": { "tpm": "required" } } (or { "features": ["tpm"] } in shorthand).

The request will fail if there are no available servers matching your criteria. Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a preferred value (see the example request below).

The request will not fail if we have no servers with that feature in our inventory.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    spot_market_request
     (required) in body

    Spot Market Request to create

    {
    "instance_attributes": "object",
    "devices_min": "integer",
    "devices_max": "integer",
    "max_bid_price": "number",
    "end_at": "string",
    "facilities": [
        "string"
    ],
    "metro": "string"
}

List spot market requests

GET
/projects/{id}/spot-market-requests

View all spot market requests for a given project.

Retrieve a spot market request

GET
/spot-market-requests/{id}

Returns a single spot market request

  • Parameters
  • id
    string  (required) in path

    SpotMarketRequest 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

Delete the spot market request

DELETE
/spot-market-requests/{id}

Deletes the spot market request.

  • Parameters
  • id
    string  (required) in path

    SpotMarketRequest UUID

    force_termination
    boolean in query

    Terminate associated spot instances