RemoteGymp · API v1

Skriv data

Uppdatera anpassade fält och underhållsfönster, kör automatisering och försök skriva igen på ett säkert sätt.

API:et och MCP stöder köade jobb, schemalagd ström, agentavinstallation, ändpunktsdiagnostik, kommandocancellation och tredjepartspatch-policies. Återanvänd idempotensnycklar och inspektera kvitton. Tillfälliga administratörsbehörigheter returneras en gång. Trafikövervakning kräver befintlig behörighet; fakturering kvarstår i applikationen.

  1. Kontrollera dina behörigheter

    Förinställningar väljer individuella funktioner; de ändrar inte åtkomstnivån. Nya inloggningsuppgifter i Inställningar använder FullAccess som standard, men endast de valda funktionerna är tillåtna. Äldre ReadWrite-inloggningsuppgifter tillåter godkända ändringar av anpassade fält och underhåll. Automatisering och enhetskontroll behöver FullAccess plus deras specifika funktioner. Kontrollera GET /v1/operations/capabilities innan du skriver. Företagsomfång och nuvarande ägarbehörigheter gäller fortfarande.

  2. Undvik att skriva över ytterligare en ändring

    Läs det anpassade fältet och dess version. Skicka ditt nya värde och den version du läste till PATCH /v1/custom-fields/{fieldId}. A 409 version_conflict betyder att någon ändrade det först. Läs det igen och avgör om din uppdatering fortfarande är lämplig.

  3. Försök igen på ett säkert sätt

    För POST /v1/maintenance-windows, skicka en Idempotency-Key-rubrik. Efter ett osäkert resultat, upprepa samma nyckel och brödtext för att hämta det ursprungliga fönstret istället för att skapa en duplikat. En ändrad brödtext med samma nyckel avvisas. DELETE /v1/maintenance-windows/{windowId} avbryter ett fönster.

  4. Kvitton för följåtgärder

    Automatiserings- och hanteringsskrivningar använder idempotencyKey i JSON-brödtexten och returnerar ett operationskvitto. Completed betyder att förfrågehanteraren är klar; Kontrollera resultatet eller domänkörningen för att se om enheten har slutfört arbetet. För OutcomeUnknown, inspektera kvittot och aktuellt tillstånd innan du bestämmer dig för vad du ska göra. Skicka aldrig automatiskt igen under en ny nyckel: åtgärden kan köras två gånger.

API-referens →

Innehållsrevision 3f225a253 · OpenAPI SHA-256: b12c42306a89