REST API v1

আপনার মনিটরিং ডেটার ওপর গড়ে তুলুন

মনিটর, ইনসিডেন্ট, সার্ভার ও স্ট্যাটাস পেজ নিয়ে প্যানেল যা করে, তার সবই HTTPS-এর ওপর সাধারণ JSON হিসেবে পাওয়া যায়। একটি token, কয়েকটি scope, অনুমানযোগ্য উত্তর।

একটি API token নিন সম্পূর্ণ API রেফারেন্স

বেস URL

https://allinonemonitor.com/api/v1

প্রতিটি উত্তর JSON: {ok:true, data, meta} অথবা {ok:false, error, code}।

অথেনটিকেশন

Authorization: Bearer aim_…

আপনার প্যানেলে API ও webhooks-এর অধীনে token তৈরি করা হয়, একবার দেখানো হয় এবং হ্যাশ করে সংরক্ষিত হয়। একটি token একটি অর্গানাইজেশনের ভেতরে, যিনি এটি তৈরি করেছেন সেই ব্যবহারকারী হিসেবে কাজ করে।

রেট লিমিট

X-RateLimit-Limit / X-RateLimit-Remaining

প্রতি token প্রতি মিনিটে, token বা আপনার প্ল্যান থেকে নির্ধারিত। সীমা ছাড়ালে Retry-After সহ 429 পাবেন। দৈনিক ব্যবহার token-এর পাশে দেখানো হয়।

দ্রুত শুরু

curl -s https://allinonemonitor.com/api/v1/me \
  -H "Authorization: Bearer aim_YOUR_TOKEN"

একটি মনিটর তৈরি করুন:

curl -s -X POST https://allinonemonitor.com/api/v1/monitors \
  -H "Authorization: Bearer aim_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type":"http","name":"Shop","url":"https://shop.example.com","interval_sec":60,"confirmations":2,"locations":["core"]}'

স্কোপসমূহ

Token তৈরির সময় scope বেছে নিন। Scope না থাকলে 403 পাবেন। একটি token কখনোই তার তৈরিকারী ব্যবহারকারীর চেয়ে বেশি কিছু করতে পারে না।

স্কোপঅনুমতি দেয়
readপ্রতিটি GET এন্ডপয়েন্ট: মনিটর, ফলাফল, আপটাইম, ইনসিডেন্ট, অ্যালার্ট, সার্ভার, স্ট্যাটাস পেজ, চ্যানেল, webhook, মেইনটেন্যান্স, লোকেশন, প্ল্যান, ব্যবহার
monitors:writeমনিটর তৈরি, পরিবর্তন, মুছে ফেলা, বিরতি ও পুনরায় চালু; মেইনটেন্যান্স উইন্ডো তৈরি
incidents:writeম্যানুয়াল ইনসিডেন্ট খোলা, আপডেট পোস্ট করা, স্বীকার করা
servers:readসার্ভার মেট্রিক সিরিজ ও নজরে রাখা সার্ভিসের তালিকা
status:writeপরবর্তী সংস্করণে স্ট্যাটাস পেজ পরিবর্তনের জন্য সংরক্ষিত
webhooks:writeআউটবাউন্ড webhook তৈরি ও মুছে ফেলা

এন্ডপয়েন্টসমূহ

পদ্ধতিপাথএটি কী করে
GET/metoken, এর অর্গানাইজেশন, প্ল্যান ও ব্যবহার
GET/monitorsমনিটরের তালিকা (ফিল্টার: status, type, q, group_id)
POST/monitorsএকটি মনিটর তৈরি করুন (ফর্মের মতোই ফিল্ড)
GET/monitors/{id}সব সেটিংসসহ একটি মনিটর
PUT/PATCH/monitors/{id}ফিল্ড বদলান; বাকিটা একই থাকে
DELETE/monitors/{id}একটি মনিটর ও তার ইতিহাস মুছে ফেলা
POST/monitors/{id}/pauseবিরতি / পুনরায় চালু (…/resume)
POST/monitors/{id}/testপ্রধান সার্ভার থেকে এখনই চেকটি চালান
GET/monitors/{id}/resultsকাঁচা চেক ফলাফল (?hours=24, সর্বোচ্চ 168)
GET/monitors/{id}/uptimeআপটাইম 24h/7d/30d/90d/365d ও দিনভিত্তিক ইতিহাস (?days=)
GET/monitors/{id}/responseরেসপন্স টাইম সিরিজ ও লোকেশন অনুযায়ী বিভাজন
GET/incidentsইনসিডেন্ট (ফিল্টার: status, resolved, monitor_id, severity, q)
POST/incidentsম্যানুয়াল ইনসিডেন্ট খুলুন
POST/incidents/{id}/updatesস্ট্যাটাস আপডেট পোস্ট করুন (তদন্ত চলছে → সমাধান হয়েছে)
POST/incidents/{id}/acknowledgeস্বীকার করুন (এস্কেলেশন থামায়)
GET/alertsঅ্যালার্ট ইতিহাস
GET/serversসার্ভার ও তাদের সর্বশেষ মেট্রিক
GET/servers/{id}/metricsCPU, মেমোরি, ডিস্ক, লোড, নেটওয়ার্ক সিরিজ (?hours=)
GET/servers/{id}/servicesনজরে রাখা সার্ভিস, কনটেইনার ও ডিস্ক
GET/status-pagesস্ট্যাটাস পেজ; …/{id} কম্পোনেন্ট ও সামগ্রিক অবস্থা যোগ করে
GET/channelsঅ্যালার্ট চ্যানেল (টার্গেট সংক্ষিপ্ত, গোপন তথ্য কখনোই নয়)
GET/webhooksআউটবাউন্ড webhook; POST দিয়ে তৈরি, DELETE দিয়ে মুছে ফেলা হয়
GET/maintenanceমেইনটেন্যান্স উইন্ডো; POST দিয়ে তৈরি হয়
GET/locationsআপনার প্ল্যানে ব্যবহারযোগ্য মনিটরিং লোকেশন
GET/plansপাবলিক প্ল্যান ও তাদের সীমা
GET/org/usageআপনার অর্গানাইজেশন তার প্ল্যানের কতটুকু ব্যবহার করছে

তালিকাগুলো ?page= ও ?per_page= (সর্বোচ্চ 100) নেয় এবং meta {page, per_page, total} ফেরত দেয়। প্রতিটি endpoint-এর রিকোয়েস্ট ও রেসপন্সের উদাহরণ API রেফারেন্সে আছে।

SDK ছাড়া উদাহরণ

PHP

<?php
$token = 'aim_YOUR_TOKEN';
$ch = curl_init('https://allinonemonitor.com/api/v1/monitors?status=down');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . $token, 'Accept: application/json'],
]);
$res = json_decode(curl_exec($ch), true);
foreach ($res['data'] as $m) {
    echo $m['name'], ' is ', $m['status'], "\n";
}

Python

import requests

API = 'https://allinonemonitor.com/api/v1'
H = {'Authorization': 'Bearer aim_YOUR_TOKEN'}

r = requests.get(f'{API}/monitors', headers=H, params={'per_page': 100})
for m in r.json()['data']:
    print(m['id'], m['name'], m['status'])

# open a manual incident
requests.post(f'{API}/incidents', headers=H, json={
    'title': 'Planned database failover',
    'severity': 'minor',
    'message': 'We are switching to the replica.'
})

Node.js

const API = 'https://allinonemonitor.com/api/v1';
const headers = { Authorization: 'Bearer aim_YOUR_TOKEN', 'Content-Type': 'application/json' };

const res = await fetch(`${API}/monitors/42/uptime?days=30`, { headers });
const { data } = await res.json();
console.log(data.uptime['30d'], '% over 30 days');

// pause it
await fetch(`${API}/monitors/42/pause`, { method: 'POST', headers });

Webhook

API ও webhooks-এর অধীনে (বা POST /webhooks দিয়ে) ইভেন্টের জন্য একটি URL সাবস্ক্রাইব করুন। প্রতিটি ডেলিভারি একটি JSON POST, যার সাথে X-AIM-Event, X-AIM-Delivery, X-AIM-Timestamp ও X-AIM-Signature হেডার থাকে। সিগনেচারটি আপনার সিক্রেট দিয়ে "timestamp.body"-এর HMAC-SHA256, যা sha256=<hex> আকারে লেখা হয়। ব্যর্থ ডেলিভারি ক্রমবর্ধমান বিরতিতে আবার চেষ্টা করা হয়; পরপর ৫০ বার ব্যর্থ হলে webhook-টি বন্ধ করে দেওয়া হয়।

ইভেন্টসমূহ: monitor.down, monitor.up, monitor.degraded, monitor.ssl_expiry, monitor.domain_expiry, monitor.dns_changed, monitor.content_changed, monitor.created, monitor.deleted, server.offline, server.online, server.alert, server.alert_cleared, server.anomaly, server.lve_fault, server.backup_failed, server.k8s, server.raid, server.smart, server.reboot, server.service_down, server.service_up, integration.service_down, integration.error, monitor.anomaly, monitor.correlated, monitor.flapping, monitor.stable, monitor.correlated_up, incident.opened, incident.updated, incident.resolved

PHP-তে একটি সিগনেচার ভেরিফাই করুন

<?php
$secret = 'your webhook secret';
$body = file_get_contents('php://input');
$ts = $_SERVER['HTTP_X_AIM_TIMESTAMP'] ?? '';
$sig = $_SERVER['HTTP_X_AIM_SIGNATURE'] ?? '';
$expected = 'sha256=' . hash_hmac('sha256', $ts . '.' . $body, $secret);
if (abs(time() - (int) $ts) > 300 || !hash_equals($expected, $sig)) {
    http_response_code(401);
    exit('bad signature');
}
$event = json_decode($body, true);
// $event['event'] e.g. "monitor.down", $event['data'] ...

Node-এ একটি সিগনেচার ভেরিফাই করুন

import crypto from 'node:crypto';

export function verify(req, rawBody, secret) {
  const ts = req.headers['x-aim-timestamp'];
  const sig = req.headers['x-aim-signature'] || '';
  const expected = 'sha256=' + crypto.createHmac('sha256', secret).update(`${ts}.${rawBody}`).digest('hex');
  const fresh = Math.abs(Date.now() / 1000 - Number(ts)) < 300;
  return fresh && sig.length === expected.length && crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(expected));
}

ত্রুটিসমূহ

HTTPcodeঅর্থ
400bad_requestবডি নেই বা JSON নয়
401unauthorizedকোনো token নেই, অথবা এটি বাতিল / মেয়াদোত্তীর্ণ / অজানা
402plan_limitআপনার প্ল্যানে এর আর একটিও অনুমোদিত নয়
403forbiddentoken-এর স্কোপ নেই, অথবা এর মালিকের অনুমতি নেই
404not_foundআপনার অর্গানাইজেশনে এমন কোনো endpoint বা অবজেক্ট নেই
405method_not_allowedভুল HTTP মেথড (Allow হেডার দেখুন)
422validationকোনো একটি ফিল্ড ভুল; errors[]-এ বলা আছে কোনটি
429rate_limitedএই মিনিটে অনেক বেশি রিকোয়েস্ট; Retry-After সেকেন্ড অপেক্ষা করুন

CORS: যেকোনো origin থেকে ব্রাউজারে GET রিকোয়েস্ট করা যায় (preflight 204 উত্তর দেয়)। অপরিচিতরা পড়তে পারে এমন ব্রাউজার কোডে token রাখবেন না।

/app/api-এ একটি token নিন