Foundry is now Mithril 🚀
Read the announcement

Reservations

Get Availability

get

Get availability slots for reservations

Authorizations
Query parameters
projectstringRequired
instance_typestringRequired
regionstringRequired
earliest_start_timeanyRequired
latest_end_timeanyRequired
Responses
200
Successful Response
application/json
get
GET /v2/reservation/availability HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer fkey_<key>
Accept: */*

[
  {
    "start_time": "2024-01-01T00:00:00Z",
    "end_time": "2024-01-01T00:00:00Z",
    "quantity": 1
  }
]

Get Reservations

get

Get all reservations for a project

Authorizations
Query parameters
next_cursorany ofOptional
anyOptional
or
nullOptional
sort_bystring · enum | nullableOptionalPossible values:
sort_dirstring · enum | nullableOptionalPossible values:
projectstringRequired
instance_typestring | nullableOptionalExample: it_abc123456
regionstring | nullableOptionalExample: us-central1-a
statusstring · enum | nullableOptionalPossible values:
limitinteger | nullableOptional
Responses
200
Successful Response
application/json
get
GET /v2/reservation HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer fkey_<key>
Accept: */*

{
  "data": [
    {
      "fid": "res_abc123456",
      "name": "text",
      "project": "proj_abc123456",
      "created_by": "user_abc123456",
      "created_at": "2024-01-01T00:00:00Z",
      "deactivated_at": "2024-01-01T00:00:00Z",
      "instance_quantity": 4,
      "instance_type": "it_abc123456",
      "external_image_version_name": "text",
      "region": "us-central1-a",
      "instances": [
        "inst_abc123456"
      ],
      "launch_specification": {
        "volumes": [
          "vol_abc123456"
        ],
        "ssh_keys": [
          "sshkey_abc123456"
        ],
        "startup_script": "text",
        "kubernetes_cluster": "clust_abc123456"
      },
      "status": "Pending",
      "start_time": "2024-01-01T00:00:00Z",
      "end_time": "2024-01-01T00:00:00Z",
      "total_price": "$47.76",
      "unit_price": "$1.99"
    }
  ],
  "next_cursor": "text"
}

Create Reservation

post

Create a new reservation

Authorizations
Body
projectstringRequiredExample: proj_abc123456
instance_typestringRequiredExample: it_abc123456
regionstringRequiredExample: us-central1-a
start_timeanyRequiredExample: 2024-01-01T00:00:00Z
end_timeanyRequiredExample: 2024-01-01T00:00:00Z
instance_quantityintegerRequiredExample: 4
namestringRequired
Responses
201
Successful Response
application/json
post
POST /v2/reservation HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer fkey_<key>
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "project": "proj_abc123456",
  "instance_type": "it_abc123456",
  "region": "us-central1-a",
  "start_time": "2024-01-01T00:00:00Z",
  "end_time": "2024-01-01T00:00:00Z",
  "instance_quantity": 4,
  "name": "text",
  "launch_specification": {
    "volumes": [
      "vol_abc123456"
    ],
    "ssh_keys": [
      "sshkey_abc123456"
    ],
    "startup_script": "text",
    "kubernetes_cluster": "clust_abc123456"
  }
}
{
  "fid": "res_abc123456",
  "name": "text",
  "project": "proj_abc123456",
  "created_by": "user_abc123456",
  "created_at": "2024-01-01T00:00:00Z",
  "deactivated_at": "2024-01-01T00:00:00Z",
  "instance_quantity": 4,
  "instance_type": "it_abc123456",
  "external_image_version_name": "text",
  "region": "us-central1-a",
  "instances": [
    "inst_abc123456"
  ],
  "launch_specification": {
    "volumes": [
      "vol_abc123456"
    ],
    "ssh_keys": [
      "sshkey_abc123456"
    ],
    "startup_script": "text",
    "kubernetes_cluster": "clust_abc123456"
  },
  "status": "Pending",
  "start_time": "2024-01-01T00:00:00Z",
  "end_time": "2024-01-01T00:00:00Z",
  "total_price": "$47.76",
  "unit_price": "$1.99"
}
PreviousLifecycle scriptsNextVolumes