Skip to main content
GET
/
os
Retrieve OSes
curl --request GET \
  --url http://anchored.host/api/os \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "ubuntu",
    "name": "Ubuntu",
    "image": "https://w7.pngwing.com/pngs/503/133/png-transparent-ubuntu-plain-logo-icon-thumbnail.png",
    "type": "LINUX",
    "templates": [
      {
        "id": 103,
        "name": "Ubuntu",
        "version": "24.04",
        "variant": "LTS",
        "createdAt": "2024-10-12T16:05:12.676Z",
        "updatedAt": "2024-11-04T04:51:04.670Z",
        "uefi": false,
        "cloud_init": true,
        "format": "qcow2",
        "architecture": "x86_64",
        "groupId": "ubuntu"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
group
string

Filter OS by group ID

Response

Successful response with OS data

​
id
string
Example:

"ubuntu"

​
name
string
Example:

"Ubuntu"

​
image
string<uri>
Example:

"https://w7.pngwing.com/pngs/503/133/png-transparent-ubuntu-plain-logo-icon-thumbnail.png"

​
type
string
Example:

"LINUX"

​
templates
object[]