Skapa en server
PUT /servers/{qualifiedName}
Skapa en ny server. Idempotent, returnerar framgång om servern redan finns och ägs av
anroparen.
Autentisering
Se Autentisering (API-nyckel). Kräver
behörigheten servers:write.
Parametrar
Sökväg
| Parameter | Typ | Obligatorisk | Beskrivning |
|---|
qualifiedName | string | Ja | Serverns kvalificerade namn, t.ex. namespace/server. Använd %2F för att URL-koda snedstrecket. |
Begäranskropp
| Fält | Typ | Obligatorisk | Beskrivning |
|---|
displayName | string | Nej | Visningsnamn, t.ex. "My Server" |
description | string | Nej | Kort beskrivning av servern |
Svar
201 Servern har skapats
| Fält | Typ | Beskrivning |
|---|
namespace | string | Namespace-namn, t.ex. "myorg" |
server | string | Servernamn inom namespacet |
displayName | string | Visningsnamn |
description | string | Beskrivning |
createdAt | string | Tidsstämpel, t.ex. "2024-01-01T00:00:00.000Z" |
| Fält | Typ | Beskrivning |
|---|
error | string | Felmeddelande |
401 Ej autentiserad
| Fält | Typ | Beskrivning |
|---|
error | string | Felmeddelande |
403 Åtkomst nekad
Namespacet ägs inte av användaren eller så saknas behörigheten servers:write.
| Fält | Typ | Beskrivning |
|---|
error | string | Felmeddelande |
404 Namespacet hittades inte
| Fält | Typ | Beskrivning |
|---|
error | string | Felmeddelande |
Kodexempel
const res = await fetch(
'https://api.silai.se/servers/myorg%2Fmy-server',
{
method: 'PUT',
headers: {
Authorization: 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
displayName: 'My Server',
description: 'A simple server'
})
}
);
const server = await res.json();
console.log(server.createdAt);