hosting
POST /v1/uptime/monitors
Start watching a web address.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.
სwhere your organisation id goes-ის ადგილი
ეს ენდპოინტი იყენებს პარამეტრად org_id. მისი გამოტოვების შემთხვევაში ზარი ფარავს თქვენი იჯარის მთელ ქვეხეს, ხოლო გაგზავნისას ზარი შეიზღუდება მხოლოდ ერთ ორგანიზაციამდე.
თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/uptime/monitors \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "url": <string> }'შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი API კონსოლში
დეტალები
Gated on uptime.manage. The address may be any public http(s) URL — we do not need to host it, and it need not belong to the customer at all. Refused with 422 when the address is not a public web address (an internal or non-HTTP address is refused in wording that does not confirm our network shape), when this organisation already watches it, or when its allowance is used up. Every account includes three monitored URLs; further capacity is the uptime_urls_10 extra.
პარამეტრები
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
org_id (query) | string | არა | Which organisation in the caller's subtree the monitor belongs to — what the dashboard's org switcher sends. ⛔ Narrow only: intersected with what the caller may already write… |
მოთხოვნის სხეული
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
url | string | დიახ | Any public http(s) address. Stored canonicalised — userinfo stripped, fragment dropped, default port removed — so what is measured, cached and shown are the same string. |
name | string | არა | What to call it on screen. Blank falls back to the host. ⛔ name, not label: label is an attribute of DRF's Field and cannot be a serializer field name, and a read key that… |
expect_text | string | არა | Text that must appear in the response for the check to pass. ⭐ This is what catches the failure a status code cannot — a site whose database has gone but whose index still answers… |
პასუხი
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
id | string | დიახ | — |
url | string | დიახ | — |
name | string | არა | — |
state | string<unknown, up, down, paused> | დიახ | ⛔ unknown is a real state and is not a synonym for up — it means "not checked yet" and is excluded from every uptime percentage. |
enabled | boolean | დიახ | — |
expect_text | string | არა | — |
site_id | string | არა | Set only when the address happens to be one of this organisation's own sites. Navigation only — the monitor works identically without it, and must, because the product exists to… |
last_result_at | string | არა | — |
last_up_at | string | არა | — |
last_down_at | string | არა | — |
created_at | string | დიახ | — |
summary | UptimeSummary | არა | — |
history | UptimeHistoryPoint[] | არა | — |
incidents | UptimeIncident[] | არა | — |
vitals | UptimeVitalsPoint[] | არა | — |
migration_offer | UptimeMigrationOffer | არა | — |
შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს
401 · 403 · 422