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 menyertakan token API lewat header Authorization:

Anda bisa mendapatkan kunci API dari Pengaturan pengguna → Pengaturan pengembang

Authorization: Bearer <API_KEY>

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.

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: