인증
Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.
조직 ID가 들어가는 위치
이 엔드포인트는 org_id을(를) 쿼리 매개변수로 사용합니다. 생략하면 테넌트 하위 트리 전체가 호출 대상이 되며, 값을 전달하면 특정 조직으로 호출 범위를 좁힐 수 있습니다.
조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
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를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. 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