List presets - Hivenet Docs

GET

https://api.hivenet.com/v1

/

presets

List hardware presets

curl --request GET \
  --url https://api.hivenet.com/v1/presets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hivenet.com/v1/presets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "region": "eu-west",
      "location": "<string>",
      "gpu": "8x RTX 4090",
      "cpu": "32",
      "memory": "192",
      "storage": "500",
      "hourly_price": "3.2000",
      "price_discounted": "2.8000"
    }
  ],
  "pagination": {
    "next": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNy0yOSJ9",
    "size": 50
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "size must not be greater than 200",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing API token",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

{
  "error": {
    "code": "TOO_MANY_REQUESTS",
    "message": "Too Many Requests",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Authorizations

Authorization

string

header

required

An API key issued by Hive Compute support. See Authentication above for how to request one.

Query Parameters

cursor

string

Opaque cursor from a previous response's pagination.next. Omit to start at the first page.

size

integer

default:50

Number of items per page.

Required range: 1 <= x <= 200

region

string

Return only presets available in this region.

sku

string

Return only presets with this SKU name, e.g. 8x-RTX-4090.

free_text_search

string

Match against SKU name, GPU model and region.

Maximum string length: 255

sort_field

enum<string>

Field to order by.

Available options:

REGION,

LOCATION,

GPU,

CPU,

MEMORY,

STORAGE,

HOURLY_PRICE

sort_direction

enum<string>

Order direction. Defaults to DESC.

Available options:

ASC,

DESC

Response

A page of presets.

data

object[]

Show child attributes

pagination

object

Cursor pagination metadata.

Show child attributes

⌘I

List hardware presets

curl --request GET \
  --url https://api.hivenet.com/v1/presets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hivenet.com/v1/presets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "region": "eu-west",
      "location": "<string>",
      "gpu": "8x RTX 4090",
      "cpu": "32",
      "memory": "192",
      "storage": "500",
      "hourly_price": "3.2000",
      "price_discounted": "2.8000"
    }
  ],
  "pagination": {
    "next": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNy0yOSJ9",
    "size": 50
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "size must not be greater than 200",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing API token",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

{
  "error": {
    "code": "TOO_MANY_REQUESTS",
    "message": "Too Many Requests",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}