RemoteGymp · API v1

Tulis data

Perbarui bidang kustom dan jendela pemeliharaan, jalankan otomatisasi, dan coba lagi penulisan dengan aman.

API dan MCP mendukung pekerjaan dalam antrean, penjadwalan daya, penghapusan agen, diagnostik titik akhir, pembatalan perintah, dan kebijakan patch pihak ketiga. Gunakan kembali kunci idempoten dan periksa tanda terima. Kredensial administrator sementara dikembalikan sekali. Pemantauan lalu lintas memerlukan hak yang sudah ada; penagihan tetap berada dalam aplikasi.

  1. Periksa izin Anda

    Preset memilih kemampuan individual; preset tidak mengubah tingkat akses. Kredensial baru di Pengaturan menggunakan FullAccess secara default, tetapi hanya kemampuan yang dipilih yang diizinkan. Kredensial ReadWrite yang lebih lama memungkinkan perubahan bidang kustom dan pemeliharaan yang disetujui. Otomatisasi dan kontrol perangkat memerlukan FullAccess ditambah kemampuan spesifiknya. Periksa GET /v1/operations/capabilities sebelum menulis. Lingkup perusahaan dan izin pemilik saat ini masih berlaku.

  2. Hindari menimpa perubahan lain

    Baca bidang kustom dan versinya. Kirim nilai baru Anda dan versi yang Anda baca ke PATCH /v1/custom-fields/{fieldId}.. Kode 409 version_conflict berarti seseorang telah mengubahnya terlebih dahulu. Baca lagi dan putuskan apakah pembaruan Anda masih sesuai.

  3. Coba lagi dengan aman

    Untuk POST /v1/maintenance-windows, kirim header Idempotency-Key. Setelah hasil yang tidak pasti, ulangi kunci dan isi yang sama untuk mengambil jendela asli daripada membuat duplikat. Isi yang diubah dengan kunci yang sama akan ditolak. DELETE /v1/maintenance-windows/{windowId} membatalkan jendela.

  4. Ikuti tanda terima tindakan

    Penulisan otomatisasi dan manajemen menggunakan idempotencyKey di dalam isi JSON dan mengembalikan tanda terima operasi. Completed berarti penanganan permintaan telah selesai; periksa hasilnya atau jalankan domain untuk mengetahui apakah perangkat telah menyelesaikan pekerjaannya. Untuk OutcomeUnknown, periksa tanda terima dan status saat ini sebelum memutuskan apa yang harus dilakukan. Jangan pernah mengirim ulang secara otomatis dengan kunci baru: tindakan tersebut dapat berjalan dua kali.

Referensi API →

Revisi konten 3f225a253 · OpenAPI SHA-256: b12c42306a89