VPS.org API

Documentação da API REST

API de Sistemas Operacionais

Lista os sistemas operacionais que você pode instalar e as versões deles. Passar um uuid de uma versão como operation_system_version_uuid quando você cria um servidor.

Pontos finais 2
Caminho base /api/v1/operating-systems
PEGAR /api/v1/operating-systems/

Lista de Sistemas Operacionais

Devolve cada sistema operacional com suas versões ativas. A lista não tem filtros.

Permissão requerida: operating-systems:list

Exemplo de solicitação

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/operating-systems/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/operating-systems/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for os_entry in response.json()["results"]:
    for version in os_entry["versions"]:
        print(os_entry["name"], version["name"], version["uuid"])
const response = await fetch('https://admin.vps.org/api/v1/operating-systems/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
for (const os of data.results) {
  for (const version of os.versions) {
    console.log(os.name, version.name, version.uuid);
  }
}

Exemplo de resposta

{
  "count": 6,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Ubuntu",
      "svg_icon": "<svg ...>",
      "versions": [
        {
          "uuid": "2fdead8f-81a2-4a23-9a81-0cf969fe1266",
          "name": "22.04 LTS x64",
          "os_name": "Ubuntu",
          "os_svg_icon": "<svg ...>",
          "is_active": true
        },
        {
          "uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
          "name": "24.04 LTS x64",
          "os_name": "Ubuntu",
          "os_svg_icon": "<svg ...>",
          "is_active": true
        }
      ]
    }
  ]
}

Abreviado: apenas um sistema operacional é mostrado e a marca SVG é cortada.

Campos de resposta

Campo Tipo Descrição
id integer Identificador do sistema operacional
name string Nome de distribuição, por exemplo, Ubuntu ou Debian
svg_icon string Marcação SVG inline do logotipo (não uma URL)
versions array Versões ativas que você pode instalar
versions[].uuid string Usar como operation_system_version_uuid ao criar um servidor
versions[].name string Versão e arquitetura, por exemplo 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Nome e ícone do sistema operacional pai
versions[].is_active boolean Indica se a versão pode ser usada para novos servidores

Códigos de status de resposta

200 Lista de sistemas operacionais recuperados com sucesso
403 Token API faltante ou inválida, ou o token carece da permissão requerida
PEGAR /api/v1/operating-systems/{id}/

Obter um Sistema Operativo

Devolve um sistema operacional e suas versões ativas, com os campos acima.

curl -X GET "https://admin.vps.org/api/v1/operating-systems/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Códigos de status de resposta

200 Sucesso
404 Não há sistema operacional com essa id

Escolhar uma Versão

Olhe versões por nome no runtime em vez de codificar um uuid, por isso a sua integração continua a funcionar quando versões são adicionadas ou aposentadas. Os detalhes de login raiz são enviados por email ao proprietário da conta uma vez que o servidor está pronto; adicione uma chave SSH ao criar o servidor para se conectar com uma chave.