Uppdatera en server

PATCH /servers/{qualifiedName}

Uppdatera metadata för en server, t.ex. visningsnamn, beskrivning, repo, ikon eller synlighet. Skicka bara de fält som ska ändras.

Autentisering

Se Autentisering (API-nyckel).

Parametrar

Sökväg

ParameterTypObligatoriskBeskrivning
qualifiedNamestringJaServerns kvalificerade namn, t.ex. namespace/server. Använd %2F för att URL-koda snedstrecket.

Begäranskropp

Alla fält är valfria. Utelämnade fält lämnas oförändrade.

FältTypBeskrivning
displayNamestringVisningsnamn
descriptionstringKort beskrivning
homepagestring \| nullURL till serverns hemsida
repositoryUrlstring \| nullURL till kodrepo
backlinkUrlstring \| nullURL för bakåtlänk
licensestring \| nullLicensidentifierare
iconUrlstring \| nullURL till ikon
unlistedbooleantrue döljer servern från publika listor

Svar

200 Servern uppdaterades

FältTypBeskrivning
successbooleantrue vid lyckad uppdatering
namespacestringNamespace-namn
serverstringServernamn inom namespacet

400 Ogiltig begäran

FältTypBeskrivning
errorstringFelmeddelande

403 Åtkomst nekad

FältTypBeskrivning
errorstringFelmeddelande

404 Servern hittades inte

FältTypBeskrivning
errorstringFelmeddelande

Kodexempel

const res = await fetch(
  'https://api.silai.se/servers/myorg%2Fmy-server',
  {
    method: 'PATCH',
    headers: {
      Authorization: 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      displayName: 'Uppdaterat namn',
      unlisted: false
    })
  }
);

const result = await res.json();
console.log(result.success);