Instatus API'ye başlangıç

Tüm uç noktalar https://api.instatus.com URL'si altındadır. Genel olarak REST mimarisini izlerler.

Tüm istekler Content-Type: application/json başlığıyla JSON olarak kodlanmalıdır.

Instatus API'den gelen yanıtlar da, hatalar dahil, JSON olarak kodlanır.

Kimlik doğrulama

Instatus API'ye yapılan isteklerde Authorization başlığı üzerinden bir API anahtarı gönderilmelidir:

Authorization: Bearer <API_KEY>

Anahtarları Panel › Geliştirici sayfasında Anahtar oluştur ile oluşturun. Her biri kendi adına sahip birden fazla anahtarınız olabilir; örneğin "GitHub Actions" veya "Terraform". Anahtarlar inst_sk_ ile başlar.

Bir anahtar neler yapabilir

Her anahtarın kendi ayarları vardır:

  • Rol: Üye, Editör ya da Business planında özel bir rol. Rol, kişilerde olduğu gibi anahtarın neleri görüntüleyip değiştirebileceğini belirler. Anahtarlar Sahip olamaz; böylece faturalandırma, roller ve silme işlemleri kişilerde kalır.
  • Erişim: Görüntüleme ve değiştirme ya da Yalnızca görüntüleme. Yalnızca görüntüleme yetkisine sahip bir anahtar, rolü neye izin verirse versin hiçbir şeyi değiştiremez.
  • Projeler: sonradan eklediğiniz projeler dahil tüm projeler ya da yalnızca seçtikleriniz.
  • Son kullanma: anahtarın çalışmayı bıraktığı tarih. Free planında bir anahtar en fazla 90 gün, Pro'da en fazla 1 yıl, Business ve Enterprise'da ise süresiz dahil istediğiniz kadar geçerli olabilir. Bir ekip sahibi Ekip ayarları › API anahtarları bölümünden daha kısa bir sınır belirleyebilir. Anahtar ayarlarından önce oluşturulan anahtarlar bundan etkilenmez; mevcut anahtarlar planınız değiştiğinde tarihlerini korur.
  • İzin verilen IP'ler: Business planında anahtar yalnızca listelediğiniz IP adreslerinden veya aralıklarından çalışır.

Bir anahtar ekibe ya da size aittir:

  • Ekip anahtarları, onları oluşturan kişi ekipten ayrıldığında da çalışmaya devam eder. CI, betikler ve entegrasyonlar için bunları kullanın.
  • Kişisel anahtarlar sizin adınıza çalışır ve asla sizin yapabileceğinizden fazlasını yapmaz. Rol olarak Sizinle aynı seçeneğini kullanabilirler ve siz ekipten ayrılırsanız çalışmayı bırakırlar.

Ekip sahipleri anahtar kurallarını Ekip ayarları › API anahtarları bölümünde belirler: bir anahtarın en fazla ne kadar geçerli olabileceği, üyelerin ekip anahtarı oluşturup oluşturamayacağı ve kişisel anahtarlara izin verilip verilmediği.

Bir anahtarın oluşturulması, değiştirilmesi, döndürülmesi ve iptal edilmesi ekibin Etkinlik sayfasında görünür; sızdığı için iptal edilen anahtarlar da öyle. Bir anahtar ya da bağlı bir uygulama üzerinden yapılan her şey orada kişi (anahtar veya uygulama adı üzerinden) şeklinde görünür.

Anahtarları güvende tutun

  • Bir anahtar yalnızca bir kez, oluşturduğunuzda gösterilir. O anda kopyalayın ve gizli bilgi olarak saklayın.
  • Bir anahtarı değiştirmek için anahtarı açın ve Döndür düğmesine tıklayın. Eski anahtarın ne kadar süre daha çalışacağını en fazla 7 güne kadar seçin; böylece onu kullanan her şeyi güncellemeye zamanınız olur.
  • Bir anahtarı menüsünden iptal ettiğinizde hemen çalışmayı bırakır.

Anahtar ayarlarından önce oluşturulan anahtarlar hiçbir değişiklik olmadan çalışmaya devam eder. Geliştirici sayfasında "Anahtar ayarlarından önce oluşturuldu" olarak görünürler; orada bunlara sınırlar ekleyebilir veya yerlerine yeni bir anahtar oluşturabilirsiniz.

Anahtar hataları

Bir anahtar bir isteği yapamadığında hata şu kodlardan birini içerir ve mesajı neyi değiştirmeniz gerektiğini söyler.

KodDurumNeden
invalid_key401Anahtar mevcut değil. Tamamını kopyaladığınızdan emin olun.
key_expired401Anahtarın son kullanma tarihi geçmiş.
key_revoked401Anahtar iptal edilmiş.
key_owner_left401Kişisel anahtarın adına çalıştığı kişi ekipten ayrılmış.
key_view_only403Anahtar yalnızca görüntüleme yetkisine sahip ve istek bir şeyi değiştiriyor.
role_not_allowed403Anahtarın rolü bunu görüntüleyemez veya değiştiremez.
ip_not_allowed403İstek, anahtarın izin vermediği bir IP adresinden geldi.
page_not_allowed403Anahtar bu projeyi kullanamaz.
account_action_not_allowed403Anahtarlar sayfa, ekip veya çalışma alanı oluşturamaz ya da kaldıramaz. Paneli kullanın.
route_not_allowed403Bu yol, belgelenmiş API'nin bir parçası değil.

Sayfa ID'nizi bulun

Sayfa ID'nizi panelde şu adımları izleyerek bulabilirsiniz:

  1. Panelinize gidin.
  2. Menüyü açmak için sol üst köşedeki projenize sağ tıklayın.
  3. Copy Project ID'ye tıklayın; sayfa ID'niz panonuza kopyalanır.
Sayfa ID'si

Hatalar

Tüm API uç noktalarının hata yanıtlarında bir kod ve bir mesaj bulunur.

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

Durum değerleri

Olası sayfa durumları. Bu, güncel API'nin (v2 ve sonrası) döndürdüğü ayrıntılı status değeridir. Eski summary.json uç noktası ve webhook bildirimleri yalnızca UP, HASISSUES ve UNDERMAINTENANCE içeren sadeleştirilmiş bir biçim kullanır.

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

Olası bileşen durumları:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Olası olay durumları:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Olası bakım durumları:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED

Uç noktalara geçin: