RemoteGymp · API v1

Skriv data

Oppdater tilpassede felt og vedlikeholdsvinduer, kjør automatisering og prøv å skrive på nytt på en sikker måte.

API-et og MCP støtter kølagte jobber, planlagt strøm, agentavinstallasjon, endepunktdiagnostikk, kommandoavbestilling og tredjeparts patch-policyer. Gjenbruk idempotensnøkler og inspiser kvitteringer. Midlertidige administratorlegitimasjoner returneres én gang. Trafikkovervåking krever eksisterende rettighet; fakturering forblir i applikasjonen.

  1. Sjekk tillatelsene dine

    Forhåndsinnstillinger velger individuelle funksjoner; de endrer ikke tilgangsnivået. Nye legitimasjonsopplysninger i Innstillinger bruker FullAccess som standard, men bare de valgte funksjonene er tillatt. Eldre ReadWrite-legitimasjonsopplysninger tillater godkjente endringer i tilpassede felt og vedlikehold. Automatisering og enhetskontroll trenger FullAccess pluss deres spesifikke funksjoner. Sjekk GET /v1/operations/capabilities før du skriver. Firmaomfang og gjeldende eiertillatelser gjelder fortsatt.

  2. Unngå å overskrive en annen endring

    Les det tilpassede feltet og dets versjon. Send den nye verdien og versjonen du leste til PATCH /v1/custom-fields/{fieldId}. A 409 version_conflict betyr at noen endret den først. Les den på nytt og avgjør om oppdateringen fortsatt er passende.

  3. Prøv på nytt på en trygg måte

    For POST /v1/maintenance-windows, send en Idempotency-Key-header. Etter et usikkert resultat, gjenta samme nøkkel og brødtekst for å hente det opprinnelige vinduet i stedet for å opprette en duplikat. En endret brødtekst med samme nøkkel avvises. DELETE /v1/maintenance-windows/{windowId} avbryter et vindu.

  4. Kvitteringer for følgehandlinger

    Automatiserings- og administrasjonsskrivinger bruker idempotencyKey i JSON-brødteksten og returnerer en operasjonskvittering. Completed betyr at forespørselsbehandleren er fullført; Sjekk resultatet eller domenekjøringen for å finne ut om enheten fullførte arbeidet. For OutcomeUnknown, kontroller kvitteringen og gjeldende status før du bestemmer deg for hva du skal gjøre. Send aldri automatisk på nytt under en ny nøkkel: handlingen kan kjøres to ganger.

API-referanse →

Innholdsrevisjon 3f225a253 · OpenAPI SHA-256: b12c42306a89