مستندات API

این مستندات برای نقاط پایانی API موجود است که بر اساس معماری REST ساخته شده‌اند. تمام نقاط پایانی API یک پاسخ JSON با کدهای پاسخ HTTP استاندارد برمی‌گردانند و به احراز هویت Bearer از طریق یک کلید API نیاز دارند.

Get your own API Key

آدرس پایه

احراز هویت

همه‌ی نقاط پایانی API نیاز به یک کلید API دارند که توسط روش احراز هویت Bearer ارسال می‌شود.

Authorization: Bearer {api_key}

مثال

curl --request GET \
--url 'https://uptimer24.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

مثال

{
    "errors": [
        {
            "title": "\u0634\u0645\u0627 \u0628\u0647 API \u062f\u0633\u062a\u0631\u0633\u06cc \u0646\u062f\u0627\u0631\u06cc\u062f.",
            "status": 401
        }
    ]
}

Status codes

200 Request completed successfully

400 Bad request - Required parameters are missing or invalid

401 Unauthorized - API key is missing or invalid

404 The requested resource was not found

429 Too many requests - Rate limit exceeded

500 Internal server error - this means there is a problem on our end

همه نتایج نقطه پایانی API با منطقه زمانی UTC کار می‌کنند مگر اینکه به‌طور دیگری مشخص شده باشد.

کاربر

نظارت بر زمان کار

نظارت‌کننده‌های DNS

نظارت سرور

ضربان قلب

نام‌های دامنه

مدیریت‌کننده‌های اعلان

صفحات وضعیت

آمار صفحه وضعیت

رویدادها

پروژه‌ها

دامنه‌های سفارشی

پرداخت‌های حساب

گزارش‌های حساب