Mulai menggunakan API Instatus

Semua endpoint berada di bawah URL https://api.instatus.com. Endpoint umumnya mengikuti arsitektur REST.

Semua permintaan harus dikodekan sebagai JSON dengan header Content-Type: application/json.

Respons dari API Instatus, termasuk galat, juga dikodekan sebagai JSON.

Autentikasi

Permintaan ke API Instatus harus mengirim kunci API lewat header Authorization:

Authorization: Bearer <API_KEY>

Buat kunci di Dasbor › Pengembang dengan Buat kunci. Anda bisa memiliki beberapa kunci, masing-masing dengan namanya sendiri, misalnya "GitHub Actions" atau "Terraform". Kunci diawali dengan inst_sk_.

Apa yang bisa dilakukan kunci

Setiap kunci memiliki pengaturannya sendiri:

  • Peran: Anggota, Editor, atau peran khusus di paket Business. Peran menentukan apa yang bisa dilihat dan diubah kunci, sama seperti untuk orang. Kunci tidak bisa menjadi Pemilik, jadi tagihan, peran, dan penghapusan tetap di tangan orang.
  • Akses: Lihat dan ubah, atau Hanya lihat. Kunci Hanya lihat tidak bisa mengubah apa pun, apa pun yang diizinkan perannya.
  • Proyek: semua proyek, termasuk yang Anda tambahkan nanti, atau hanya yang Anda pilih.
  • Kedaluwarsa: tanggal kunci berhenti bekerja. Di paket Free, kunci bisa berlaku hingga 90 hari, di Pro hingga 1 tahun, dan di Business serta Enterprise selama yang Anda mau, termasuk tanpa kedaluwarsa. Pemilik tim bisa menetapkan batas yang lebih pendek di Pengaturan tim › Kunci API. Kunci yang dibuat sebelum ada pengaturan kunci tidak terpengaruh, dan kunci yang sudah ada tetap memakai tanggalnya saat paket Anda berubah.
  • IP yang diizinkan: di paket Business, kunci hanya bekerja dari alamat atau rentang IP yang Anda cantumkan.

Kunci dimiliki oleh tim atau oleh Anda:

  • Kunci tim tetap bekerja saat orang yang membuatnya keluar dari tim. Gunakan untuk CI, skrip, dan integrasi.
  • Kunci pribadi bertindak sebagai Anda dan tidak pernah melakukan lebih dari yang bisa Anda lakukan. Kunci ini bisa memakai Sama seperti Anda sebagai perannya, dan berhenti bekerja jika Anda keluar dari tim.

Pemilik tim mengatur aturan kunci di Pengaturan tim › Kunci API: berapa lama maksimal sebuah kunci berlaku, apakah anggota boleh membuat kunci tim, dan apakah kunci pribadi diizinkan.

Pembuatan, perubahan, rotasi, dan pencabutan kunci muncul di Aktivitas tim, begitu juga kunci yang dicabut karena bocor. Semua yang dilakukan melalui kunci atau aplikasi yang terhubung muncul di sana sebagai orang melalui nama kunci atau aplikasi.

Menjaga keamanan kunci

  • Kunci hanya ditampilkan sekali, saat Anda membuatnya. Salin saat itu juga dan simpan sebagai rahasia.
  • Untuk mengganti kunci, buka kunci tersebut dan klik Rotasi. Pilih berapa lama kunci lama tetap bekerja, hingga 7 hari, agar Anda punya waktu memperbarui semua yang menggunakannya.
  • Cabut kunci dari menunya, dan kunci langsung berhenti bekerja.

Kunci yang dibuat sebelum ada pengaturan kunci tetap bekerja tanpa perubahan. Kunci ini muncul sebagai "Dibuat sebelum ada pengaturan kunci" di halaman Pengembang, tempat Anda bisa menambahkan batasan atau menggantinya dengan kunci baru.

Galat kunci

Saat kunci tidak bisa melakukan permintaan, galatnya memuat salah satu kode berikut, dan pesannya menjelaskan apa yang perlu diubah.

KodeStatusAlasan
invalid_key401Kunci tidak ada. Pastikan Anda menyalinnya secara lengkap.
key_expired401Kunci sudah melewati tanggal kedaluwarsanya.
key_revoked401Kunci sudah dicabut.
key_owner_left401Orang yang diwakili kunci pribadi sudah keluar dari tim.
key_view_only403Kunci berstatus Hanya lihat dan permintaan mengubah sesuatu.
role_not_allowed403Peran kunci tidak bisa melihat atau mengubah ini.
ip_not_allowed403Permintaan berasal dari alamat IP yang tidak diizinkan kunci.
page_not_allowed403Kunci tidak bisa menggunakan proyek ini.
account_action_not_allowed403Kunci tidak bisa membuat atau menghapus halaman, tim, atau ruang kerja. Gunakan dasbor.
route_not_allowed403Rute ini bukan bagian dari API yang didokumentasikan.

Mendapatkan ID Halaman Anda

ID Halaman Anda bisa ditemukan di dashboard dengan langkah berikut:

  1. Buka dashboard Anda.
  2. Klik kanan proyek Anda di pojok kiri atas untuk membuka menunya.
  3. Klik Copy Project ID dan ID halaman Anda akan tersalin ke papan klip.
ID halaman

Galat

Semua endpoint API memuat kode dan pesan di dalam respons galatnya.

{
"error": {
"code": "forbidden",
"message": "Not authorized"
}
}

Nilai Status

Status halaman yang mungkin. Ini adalah status terperinci yang dikembalikan API saat ini (v2 dan setelahnya). Endpoint summary.json lama dan notifikasi webhook memakai bentuk ringkas yang hanya berisi UP, HASISSUES, dan UNDERMAINTENANCE.

  • UP
  • HASISSUES
  • ALLUNDERMAINTENANCE
  • ALLDEGRADEDPERFORMANCE
  • ALLPARTIALOUTAGE
  • ALLMINOROUTAGE
  • ALLMAJOROUTAGE
  • SOMEUNDERMAINTENANCE
  • SOMEDEGRADEDPERFORMANCE
  • SOMEPARTIALOUTAGE
  • SOMEMINOROUTAGE
  • SOMEMAJOROUTAGE
  • ONEUNDERMAINTENANCE
  • ONEDEGRADEDPERFORMANCE
  • ONEPARTIALOUTAGE
  • ONEMINOROUTAGE
  • ONEMAJOROUTAGE

Status komponen yang mungkin:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Status insiden yang mungkin:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Status pemeliharaan yang mungkin:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Lompat ke endpoint: