Kom igång
- Logga in på ditt ServerPrism-konto.
- Öppna Konto → API-uppgifter och skapa en token.
- Välj den minsta uppsättning scopes som din integration behöver.
- Kopiera token en gång när den visas: vi sparar den aldrig i klartext och kan inte återskapa den.
- Använd token som Bearer-uppgift mot endpoints nedan.
Alla anrop går till https://serverprism.com. Alla svar är JSON. Alla tidsstämplar är UTC i ISO-8601.
Autentisering
Skicka token i en Authorization: Bearer-header. Tokens är personliga: varje token tillhör en enda ServerPrism-kund och kan bara agera på den kundens tjänster.
curl https://serverprism.com/api/v1/client/servers \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Accept: application/json"Tokens som du skapar i kontrollpanelen är personliga åtkomsttokens. OAuth-flödena client credentials och authorization code erbjuds inte för kundintegrationer just nu.
Scopes
Varje token har ett eller flera scopes. En endpoint kräver ett visst scope: saknas det svarar den med 403.
| Scope | Tillåter |
|---|---|
servers:read |
Visa dina servrar (status, resurser, grundinformation) |
servers:control |
Skicka strömsignaler (start/stopp/omstart/kill) och konsolkommandon till dina servrar |
backups:create |
Skapa nya säkerhetskopior av dina servrar (räknas mot dina kopieringsplatser) |
billing:read |
Visa faktureringsuppgifter för dina tjänster och dina fakturor (inklusive PDF-nedladdning) |
tickets:read |
Visa dina supportärenden och svaren i dem |
tickets:write |
Öppna nya supportärenden och svara på dina befintliga ärenden |
account:read |
Visa dina grundläggande kontouppgifter (namn, e-postadress) |
Anropsgränser
Gränserna gäller per minut och tillämpas två gånger: en gång per token och en gång för alla tokens på ditt konto (den som tar slut först gäller). De är medvetet försiktiga. Behöver du mer, öppna ett ärende och berätta om din integration.
| Bucket | Gräns | Endpoints |
|---|---|---|
read |
60 per token, 120 per konto | Alla GET-endpoints utom faktura-PDF:en |
control |
20 per token, 30 per konto | Ström, kommando, skapa säkerhetskopia, faktura-PDF |
tickets |
5 per token, 10 per konto; plus 1 nytt ärende per 30 sekunder | Öppna ärende, svara på ärende |
Överskrids en gräns svarar API:et 429 Too Many Requests med en Retry-After-header. Varje svar innehåller X-RateLimit-Limit och X-RateLimit-Remaining för tokenets bucket. Vänta och försök igen; loopa aldrig tätt mot en 429.
Fel
Felsvar är JSON med ett läsbart message och, för API-specifika fel, en stabil maskinläsbar error-kod som service_not_active. Valideringsfel (422) innehåller dessutom ett errors-objekt ordnat per fält.
| Status | Betydelse |
|---|---|
| 401 | Token saknas eller är ogiltig. |
| 403 | Token saknar det scope som krävs. |
| 404 | Hittades inte, eller tillhör inte dig (båda ser likadana ut med flit). |
| 409 | Servern är i ett läge som inte tillåter detta: service_not_active (spärrad, avslutad, väntande), service_paused (kalllagring), server_offline, server_busy, backup_limit_reached, backup_in_progress. |
| 422 | Anropets innehåll klarade inte valideringen. |
| 429 | Anropsgränsen är överskriden. |
| 503 | Noden bakom är tillfälligt otillgänglig. Försök igen efter en kort stund. |
Endpoints
Server-ID i URL:erna är det numeriska tjänst-ID:t, detsamma som i din URL /services/{id}. Alla sökvägar nedan är relativa till https://serverprism.com/api/v1/client. Lista-endpoints tar page och per_page (högst 100) och returnerar ett meta-block med total och last_page.
/api/v1/client/serversscope: servers:readListar varje aktiv eller spärrad tjänst som tokenägaren har. Billig att anropa ofta: den kontaktar inte servern.
Anrop
curl https://serverprism.com/api/v1/client/servers \
-H "Authorization: Bearer YOUR_TOKEN"Svar
{
"data": [
{
"id": 1234,
"product": "Minecraft 4 GB",
"service_status": "active",
"name": "Fred's Minecraft",
"paused": false,
"game": { "slug": "minecraft", "name": "Minecraft", "runtime": "paper", "version": "1.21.4" },
"expires_at": "2026-11-01T00:00:00+00:00"
}
]
}/api/v1/client/servers/{id}scope: servers:readAllt från lista-endpointen plus anslutningsadressen som spelarna använder, serverns portar, dess gränser och live-resursanvändning så gott det går.
Svar
{
"data": {
"id": 1234,
"name": "Fred's Minecraft",
"service_status": "active",
"paused": false,
"game": { "slug": "minecraft", "name": "Minecraft", "runtime": "paper", "version": "1.21.4" },
"expires_at": "2026-11-01T00:00:00+00:00",
"address": "fredcraft.example.com",
"allocations": [
{ "ip": "203.0.113.7", "port": 25565, "primary": true, "notes": null }
],
"limits": {
"memory_mb": 4096,
"disk_mb": 25600,
"cpu_percent": 200
},
"resources": {
"current_state": "running",
"memory_bytes": 2147483648,
"cpu_absolute": 18.5,
"disk_bytes": 7300000000,
"network_rx_bytes": 12345678,
"network_tx_bytes": 87654321,
"uptime_ms": 3600000
}
}
}Blocket resources kan vara null om noden var onåbar en kort stund. Försök igen eller titta på statusindikatorn i panelen.
/api/v1/client/servers/{id}/powerscope: servers:controlSkickar en strömsignal till servern. Fungerar bara medan tjänsten är aktiv: spärrade, avslutade eller pausade tjänster svarar 409.
Anropets innehåll
{
"signal": "start" // one of: "start", "stop", "restart", "kill"
}kill avbryter processen hårt utan att ge spelet chans att spara. Använd stop för en ordnad nedstängning av spel med sparad värld.
Exempel
curl -X POST https://serverprism.com/api/v1/client/servers/1234/power \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"signal":"restart"}'Svar
{ "data": { "signal": "restart", "sent": true } }/api/v1/client/servers/{id}/commandscope: servers:controlSkickar ett enda konsolkommando till servern som körs (t.ex. say hello, stop, whitelist add Notch). Servern måste vara igång; annars får du 409 server_offline.
Anropets innehåll
{
"command": "say Server restarting in 5 minutes"
}En rad, högst 1024 tecken. Radbrytningar och andra styrtecken avvisas med 422: skicka ett anrop per kommando.
Svar
{ "data": { "command": "say Server restarting in 5 minutes", "sent": true } }/api/v1/client/servers/{id}/backupsscope: servers:readListar serverns säkerhetskopior och dina kopieringsplatser. Platserna delas mellan alla dina servrar och växer med RAM i din plan.
Svar
{
"data": [
{
"uuid": "6f1c0e2a-...",
"name": "nightly",
"status": "completed", // "in_progress" | "completed" | "failed"
"size_bytes": 734003200,
"locked": false,
"created_at": "2026-09-30T03:00:00+00:00",
"completed_at": "2026-09-30T03:04:12+00:00"
}
],
"meta": { "quota": { "used": 2, "total": 3, "can_create_more": true, "is_trial": false } }
}/api/v1/client/servers/{id}/backupsscope: backups:createStartar en säkerhetskopia och svarar 202 direkt. Kopiorna körs i bakgrunden: anropa lista-endpointen tills status är completed eller failed. Varje kopia använder en plats; när platserna är slut får du 409 backup_limit_reached. Provplaner inkluderar inga säkerhetskopior (403). Att återställa och radera säkerhetskopior går bara i kontrollpanelen.
Anropets innehåll (valfritt)
{ "name": "before-1.21-update" }Svar (202)
{ "data": { "uuid": "9a2b...", "name": "before-1.21-update", "status": "in_progress", "size_bytes": 0, "locked": false, "created_at": "2026-10-01T12:00:00+00:00", "completed_at": null } }/api/v1/client/accountscope: account:readSvar
{ "data": { "id": 42, "first_name": "Fred", "last_name": "Smith", "email": "fred@example.com", "email_verified": true, "created_at": "2025-03-01T10:00:00+00:00" } }/api/v1/client/servicesscope: billing:readAlla dina tjänster oavsett status, med faktureringsuppgifter. Valfritt filter ?status= med ett av pending, provisioning, active, suspended, cancelled, failed.
Svar
{
"data": [
{
"id": 1234,
"name": "Fred's Minecraft",
"product": "Minecraft 4 GB",
"status": "active",
"paused": false,
"plan": { "name": "Monthly", "type": "recurring", "billing_period": 1, "billing_unit": "month" },
"quantity": 1,
"price": { "amount": "8.00", "currency": "EUR", "formatted": "€8.00" },
"next_due_date": "2026-11-01T00:00:00+00:00",
"cancellation_requested": false,
"cancellation_type": null,
"created_at": "2026-05-01T09:12:00+00:00"
}
],
"meta": { "current_page": 1, "per_page": 25, "total": 1, "last_page": 1 }
}/api/v1/client/invoicesscope: billing:readDina fakturor, nyaste först. Valfritt filter ?status=pending|paid|cancelled.
Svar
{
"data": [
{
"id": 5512,
"number": "SP-2026-05512",
"status": "pending",
"currency": "EUR",
"total": { "amount": "8.00", "currency": "EUR", "formatted": "€8.00" },
"tax": { "amount": "1.60", "currency": "EUR", "formatted": "€1.60" },
"remaining": { "amount": "8.00", "currency": "EUR", "formatted": "€8.00" },
"due_at": "2026-10-04T00:00:00+00:00",
"created_at": "2026-09-27T00:00:00+00:00",
"pdf_url": "https://serverprism.com/api/v1/client/invoices/5512/pdf",
"dashboard_url": "https://serverprism.com/invoices/SP-2026-05512"
}
],
"meta": { "current_page": 1, "per_page": 25, "total": 1, "last_page": 1 }
}För att betala en faktura, öppna dess dashboard_url. API:et flyttar aldrig pengar.
/api/v1/client/invoices/{id}scope: billing:readSamma fält som i listan plus fakturaraderna. {id} är det numeriska id, inte fakturanumret.
Svar (utdrag)
{
"data": {
"id": 5512,
"status": "pending",
"items": [
{ "description": "Minecraft 4 GB (Oct 01, 2026 - Nov 01, 2026)", "quantity": 1, "unit_price": "8.00", "total": "8.00", "service_id": 1234 }
]
}
}/api/v1/client/invoices/{id}/pdfscope: billing:readLaddar ner fakturan som PDF (application/pdf), samma dokument som nedladdningsknappen i kontrollpanelen. Räknas mot bucketen control.
curl -o invoice.pdf https://serverprism.com/api/v1/client/invoices/5512/pdf \
-H "Authorization: Bearer YOUR_TOKEN"/api/v1/client/ticketsscope: tickets:readDina supportärenden, senast uppdaterade först. Valfritt filter ?status=open|replied|closed. replied betyder att vårt team har svarat och väntar på dig.
Svar
{
"data": [
{
"id": 1301,
"subject": "Server lagging in the evening",
"status": "replied",
"priority": "medium",
"department": "Support",
"service_id": 1234,
"messages_count": 3,
"last_message_at": "2026-10-01T09:30:00+00:00",
"created_at": "2026-09-30T18:02:00+00:00",
"updated_at": "2026-10-01T09:30:00+00:00",
"dashboard_url": "https://serverprism.com/tickets/1301"
}
],
"meta": { "current_page": 1, "per_page": 25, "total": 1, "last_page": 1 }
}/api/v1/client/tickets/{id}scope: tickets:readÄrendet och dess konversation, äldsta meddelandet först. author är you eller staff. Bilagor listas med namn; ladda ner dem i kontrollpanelen.
Svar (utdrag)
{
"data": {
"id": 1301,
"status": "replied",
"messages": [
{ "id": 9001, "author": "you", "author_name": "Fred Smith", "message": "TPS drops every evening", "attachments": [], "created_at": "2026-09-30T18:02:00+00:00" },
{ "id": 9007, "author": "staff", "author_name": "ServerPrism Support", "message": "We moved you to a quieter host...", "attachments": [], "created_at": "2026-10-01T09:30:00+00:00" }
]
}
}/api/v1/client/ticketsscope: tickets:writeÖppnar ett ärende. department är obligatoriskt och måste vara en av avdelningarna i formuläret för nya ärenden i kontrollpanelen. priority är low (standard), medium eller high. service_id är valfritt och måste vara en av dina tjänster. Ett nytt ärende per 30 sekunder och konto. Svarar 201 med samma innehåll som Hämta ärende.
Anropets innehåll
{
"subject": "Server lagging in the evening",
"message": "TPS drops to ~12 between 19:00 and 22:00 CET.",
"department": "Support",
"priority": "medium",
"service_id": 1234
}/api/v1/client/tickets/{id}/messagesscope: tickets:writeLägger till ditt svar i ett av dina ärenden (upp till 20 000 tecken). Ett svar på ett stängt ärende öppnar det igen, precis som i kontrollpanelen. Svarar 201 med det nya meddelandet.
Anropets innehåll
{ "message": "Still happening tonight, see the timings report." }Inte tillgängligt via API:et
Med flit kan API:et inte betala, avsluta, uppgradera eller nedgradera tjänster, använda kuponger, radera eller återställa säkerhetskopior eller radera filer. De åtgärderna finns i kontrollpanelen, där du ser exakt vad de gör innan du bekräftar.
Versionshantering
Namnrymden v1 är stabil. Brytande ändringar kommer bara i en ny namnrymd (v2); vi kan lägga till nya fält i befintliga svar utan förvarning, så skriv din klient så att den ignorerar okända nycklar.
Önskemål om funktioner och felrapporter: öppna ett ärende och nämn "API".