RemoteGymp · API v1

Tulis data

Kemas kini medan tersuai dan tetingkap penyelenggaraan, jalankan automasi dan cuba tulis semula dengan selamat.

API dan MCP menyokong kerja yang beratur, kuasa berjadual, nyahpasang ejen, diagnostik terminal, pembatalan arahan dan polisi tampalan pihak ketiga. Gunakan semula kekunci idempotensi dan periksa resit. Kredensial pentadbir sementara dikembalikan sekali. Pemantauan trafik memerlukan hak sedia ada; pengebilan kekal dalam aplikasi.

  1. Semak kebenaran anda

    Pratetap memilih keupayaan individu; ia tidak mengubah tahap akses. Kelayakan baharu dalam Tetapan menggunakan FullAccess secara lalai, tetapi hanya keupayaan yang dipilih dibenarkan. Kelayakan ReadWrite yang lebih lama membenarkan perubahan medan tersuai dan penyelenggaraan yang diluluskan. Automasi dan kawalan peranti memerlukan FullAccess serta keupayaan khususnya. Semak GET /v1/operations/capabilities sebelum menulis. Skop syarikat dan kebenaran pemilik semasa masih terpakai.

  2. Elakkan menulis ganti perubahan lain

    Baca medan tersuai dan versinya. Hantar nilai baharu anda dan versi yang anda baca ke PATCH /v1/custom-fields/{fieldId}. A 409 version_conflict bermaksud seseorang telah mengubahnya terlebih dahulu. Bacanya sekali lagi dan tentukan sama ada kemas kini anda masih sesuai.

  3. Cuba semula dengan selamat

    Untuk POST /v1/maintenance-windows, hantar pengepala Idempotency-Key. Selepas keputusan yang tidak menentu, ulangi kekunci dan badan yang sama untuk mendapatkan tetingkap asal dan bukannya mencipta pendua. Badan yang diubah dengan kekunci yang sama ditolak. DELETE /v1/maintenance-windows/{windowId} membatalkan tetingkap.

  4. Ikuti resit tindakan

    Penulisan automasi dan pengurusan menggunakan idempotencyKey dalam badan JSON dan mengembalikan resit operasi. Completed bermaksud pengendali permintaan selesai; semak hasil atau jalan domain untuk mengetahui sama ada peranti telah menyelesaikan kerja. Untuk OutcomeUnknown, periksa resit dan keadaan semasa sebelum memutuskan apa yang perlu dilakukan. Jangan sekali-kali menghantar semula secara automatik di bawah kunci baharu: tindakan boleh dijalankan dua kali.

Rujukan API →

Semakan kandungan 3f225a253 · OpenAPI SHA-256: b12c42306a89