API reference Version 1 · OpenAPI 3.1 · Dashboard
Introduction
The Cometly API lets you create branded short links and QR codes, connect your own domains, watch their health and reputation, and report conversions — everything the dashboard does.
Base URL https://api.cometly.site
Format JSON · UTF-8
Times ISO 8601, UTC
Quick start
In the dashboard, open Settings → API keys and create a key with the links:write scope. Copy it — it’s shown once.
Paste it in the API key box at the top of this page to fill in every example (it stays in this tab; nothing is stored or sent).
Create your first link:
cURL Copy
curl -X POST "https://api.cometly.site/v1/links" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{"url": "https://kesari.shop/diwali", "slug": "diwali"}'
IDs carry a prefix that tells you what they are: lnk_ link, dom_ domain, ws_ workspace, usr_ user, key_ API key, job_ job, cnv_ conversion, clk_ click.
Authentication
Send your key as a bearer token on every /v1 request:
Authorization: Bearer cmt_live_…
Keys belong to a workspace, carry scopes , and can be limited to some domains (allowed_domain_ids). A key can never have more access than the person who created it. Keep keys on your server — the API refuses browser calls from other websites.
Repeatedly sending invalid keys from one network gets that network temporarily blocked (403 ip-blocked).
The dashboard uses cookie sessions instead (see Dashboard sign-in ); those requests also need X-CSRF-Token on writes and X-Workspace-Id to pick a workspace.
Scopes & roles
Give each key only the scopes it needs. Team members get scopes from their role.
Scope Allows Owner / Admin Member Viewer links:readRead links, QR codes’ settings, health and safety ✓ ✓ ✓ links:writeCreate and edit links, builders, QR designs ✓ ✓ — links:deleteDelete and purge links ✓ ✓ — domains:readRead domains, DNS guides, reputation ✓ ✓ ✓ domains:writeAdd, verify and edit domains ✓ ✓ — domains:deleteDelete or cancel domains ✓ — — stats:readTraffic quality and analytics ✓ ✓ ✓ qr:readDownload QR codes ✓ ✓ ✓ webhooks:writeManage webhooks ✓ — — keys:writeCreate, list and revoke API keys ✓ — — account:readWorkspace, plan, usage, team, jobs ✓ ✓ ✓ conversions:readList conversions ✓ ✓ ✓ conversions:writeReport conversions ✓ ✓ — integrations:writeConnect Meta CAPI and GA4 ✓ — — team:writeInvite, change and remove members ✓ — —
Errors
Errors use problem details with Content-Type: application/problem+json. Branch on type (a stable code); show detail to people. Validation errors list each bad field.
422 application/problem+json
{
"type" : "validation-error" ,
"title" : "Unprocessable Entity" ,
"status" : 422 ,
"detail" : "Request validation failed" ,
"errors" : [
{
"field" : "slug" ,
"message" : "Use 1–60 letters, digits, - or _"
}
]
}
400 Malformed JSON or headers
401 Missing, invalid, revoked or expired key
402 Plan limit reached (link-limit-reached, domain-limit-reached)
403 Missing scope (insufficient-scope), role, or domain access; suspended workspace
404 Not found — or not in your workspace
409 Conflict (slug-taken, domain-in-use…)
412 If-Match didn’t match the current ETag
422 Validation failed, or destination-blocked (phishing/malware)
429 Rate limited — wait Retry-After seconds
503 A dependency is briefly unavailable; nothing was changed — retry with backoff
Retries & concurrency
Idempotency. Send Idempotency-Key: <unique string> on any POST. For 24 hours a retry with the same key and body returns the original response (with Idempotent-Replayed: true) instead of creating a duplicate. Reusing a key with a different body is 422 idempotency-key-reused; a retry while the first is still running is 409 operation-in-progress.
Safe edits. Links return an ETag. Send it back as If-Match on PATCH and you’ll get 412 instead of overwriting a change someone else just made.
Rate limits
Each key may make 60 / 600 / 3,000 requests per minute on Free / Pro / Business (your number is limits.api_rate_limit in GET /v1/me); a workspace may use 3× that across all keys. Every response carries:
RateLimit-Limit: 600
RateLimit-Remaining: 597
RateLimit-Reset: 41
When you go over you get 429 with Retry-After (seconds). There is also a per-network limit in front of the API to absorb floods.
Webhooks
Coming soon: the endpoints to register webhook URLs (POST /v1/webhooks) are in the next build phase. Events are already recorded in this format, so you can build your receiver now.
Each delivery is a POST with a JSON event. Deliveries are at-least-once — dedupe on id.
Event
{
"id" : "evt_0f8c2b6e-5d1a-4c4e-9a63-2b7d1f0e9c11" ,
"type" : "domain.blocklisted" ,
"created_at" : "2026-11-03T10:05:00.000Z" ,
"data" : {
"domain_id" : "dom_kd292xv8n8tg" ,
"hostname" : "go.kesari.shop" ,
"status" : "listed" ,
"listed_on" : [
"meta" ,
"spamhaus_dbl"
]
}
}
Verify the X-Cometly-Signature header — an HMAC-SHA256 of <t>.<raw body> with your webhook secret — before trusting the body:
Node.js Copy
import { createHmac, timingSafeEqual } from 'node:crypto';
// header: X-Cometly-Signature: t=1793700000,v1=5f2b…
export function verifyCometly(rawBody, header, secret) {
const parts = Object.fromEntries(header.split(',').map((p) => p.split('=')));
const age = Math.abs(Date.now() / 1000 - Number(parts.t));
if (!parts.t || !parts.v1 || age > 300) return false; // replayed or stale
const expected = createHmac('sha256', secret).update(`${parts.t}.${rawBody}`).digest('hex');
return expected.length === parts.v1.length &&
timingSafeEqual(Buffer.from(expected), Buffer.from(parts.v1));
}
Events
link.createdA link was created link.updatedA link changed (changed lists the fields) link.disabledPaused by a user link.deletedSoft-deleted link.restoredRestored link.purgedPermanently deleted link.expiredReached expires_at or max_clicks link.flaggedDisabled for a malicious destination or by staff link.destination_downDestination confirmed down link.destination_recoveredBack up link.ab_completedA winner was picked conversion.createdA conversion was recorded domain.verifiedDNS verified domain.tls_issuedHTTPS is live domain.misconfiguredDNS stopped pointing at us domain.failedNever verified within 72 h domain.disabledMisconfigured for 14 days, or over the plan limit domain.deletion_scheduledDeletion started domain.restoredRestored domain.deletedGone domain.suspendedSuspended by staff domain.blocklistedNewly listed by Meta, Google, Spamhaus… domain.reputation_recoveredNo longer listed job.completedA job finished job.failedA job failed
Coming soon
These endpoints are reserved and currently answer 501 not-implemented:
GET /v1/links/:id/statsPhase 4 GET /v1/links/:id/clicksPhase 4 POST /v1/links/bulk-deletePhase 3 GET /v1/stats/overviewPhase 4 GET /v1/stats/timeseriesPhase 4 GET /v1/stats/topPhase 4 GET /v1/usagePhase 3 POST /v1/webhooksPhase 3 GET /v1/webhooksPhase 3 POST /v1/exportsPhase 7
Account Who you are, your plan, limits and usage.
GET /v1/me
API key account:read
curl "https://api.cometly.site/v1/me" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/me', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/me",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"workspace" : {
"id" : "ws_tg5pvg2u7mwj" ,
"name" : "Kesari Foods" ,
"status" : "active" ,
"default_domain_id" : "dom_kd292xv8n8tg"
},
"plan" : {
"id" : "pro" ,
"name" : "Pro"
},
"limits" : {
"max_domains" : 10 ,
"max_links_month" : 50000 ,
"api_rate_limit" : 600
},
"usage" : {
"domains" : 2 ,
"links_this_month" : 318
},
"credits" : {
"balance" : 4820
},
"api_key" : {
"id" : "key_wnvafcpj2ppr" ,
"scopes" : [
"links:read" ,
"links:write"
],
"allowed_domains" : null
},
"member" : null
}
Links Create, list, edit, pause, delete and restore short links. Deleted links can be restored for 30 days; their slugs are then quarantined for 30 more days so old posts can’t reach a new page.
POST /v1/links
API key links:write
Send Idempotency-Key to retry safely. The response carries an ETag for conditional updates. Destinations are safety-checked before anything is saved.
Headers Body urlstring
Destination (http/https). Required unless builder is used. UTM fields are merged into it.
domainstring
Short domain hostname. Default: the workspace default, else the shared domain.
slugstring
1–60 chars a-z 0-9 - _, case-insensitive. Omit for a generated one.
builderobject
Instead of url: {type: "whatsapp"|"upi"|"maps"|"telegram"|"app", …} — see Link builders.
titlestring
Up to 200 chars, for your own reference.
tagsstring[]
Up to 20 tags of ≤ 50 chars.
utmobject
{source, medium, campaign, term, content} added to the destination and rule URLs.
rulesobject[]
Up to 20 {if: {device|country|language|city}, url}; first match wins. Devices: ios, android, mobile, desktop.
deep_linkobject
{mode: "auto"|"custom"|"off", ios_url, android_package, escape_in_app} — open the app instead of the browser.
ab_testobject
{variants: [{url, weight}…2–4], ends_at, auto_winner, threshold}. The first variant is the control; weights sum to 100.
conversion_trackingboolean
Adds cmt_id=<click id> to the destination so you can report conversions.
fallback_urlstring
Served automatically while the destination is down.
previewobject
{title, description, image_url} shown by WhatsApp/Facebook/LinkedIn crawlers.
passwordstring
4–128 chars; visitors must enter it.
expires_atstring (date-time)
Link stops working after this time.
max_clicksinteger
Link stops after this many clicks.
metadataobject
Your own JSON (≤ 4 KB), returned and sent in webhooks.
Errors 409 slug-takenThe slug is used on that domain 409 slug-quarantinedThe slug belonged to a deleted link in the last 30 days 402 link-limit-reachedMonthly link limit for your plan 422 destination-blockedDestination is phishing/malware
curl -X POST "https://api.cometly.site/v1/links" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Idempotency-Key: diwali-ig-2026" \
-H "Content-Type: application/json" \
-d '{
"url": "https://kesari.shop/diwali",
"domain": "go.kesari.shop",
"slug": "diwali",
"title": "Diwali sale",
"tags": [
"instagram"
],
"utm": {
"source": "instagram",
"medium": "paid",
"campaign": "diwali26"
},
"rules": [
{
"if": {
"device": "ios"
},
"url": "https://apps.apple.com/in/app/kesari/id123"
}
],
"conversion_tracking": true,
"fallback_url": "https://kesari.shop/"
}'const res = await fetch('https://api.cometly.site/v1/links', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
'Idempotency-Key': 'diwali-ig-2026',
},
body: JSON.stringify({
"url": "https://kesari.shop/diwali",
"domain": "go.kesari.shop",
"slug": "diwali",
"title": "Diwali sale",
"tags": [
"instagram"
],
"utm": {
"source": "instagram",
"medium": "paid",
"campaign": "diwali26"
},
"rules": [
{
"if": {
"device": "ios"
},
"url": "https://apps.apple.com/in/app/kesari/id123"
}
],
"conversion_tracking": true,
"fallback_url": "https://kesari.shop/"
}),
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/links",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} ", "Idempotency-Key": "diwali-ig-2026"},
json={
"url": "https://kesari.shop/diwali",
"domain": "go.kesari.shop",
"slug": "diwali",
"title": "Diwali sale",
"tags": ["instagram"],
"utm": {
"source": "instagram",
"medium": "paid",
"campaign": "diwali26",
},
"rules": [
{
"if": {
"device": "ios",
},
"url": "https://apps.apple.com/in/app/kesari/id123",
},
],
"conversion_tracking": True,
"fallback_url": "https://kesari.shop/",
},
)
print(res.json())201 application/json Copy
{
"id" : "lnk_594ufv74rqre" ,
"short_url" : "https://go.kesari.shop/diwali" ,
"qr_url" : "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" ,
"domain" : "go.kesari.shop" ,
"slug" : "diwali" ,
"destination" : "https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26" ,
"title" : "Diwali sale" ,
"tags" : [
"instagram"
],
"utm" : {
"source" : "instagram" ,
"medium" : "paid" ,
"campaign" : "diwali26"
},
"preview" : null ,
"rules" : [
{
"if" : {
"device" : "ios"
},
"url" : "https://apps.apple.com/in/app/kesari/id123"
}
],
"has_password" : false ,
"expires_at" : null ,
"max_clicks" : null ,
"status" : "active" ,
"disabled_reason" : null ,
"metadata" : {},
"type" : "url" ,
"deep_link" : {
"mode" : "off"
},
"ab_test" : null ,
"conversion_tracking" : true ,
"fallback_url" : "https://kesari.shop/" ,
"health" : {
"state" : "unknown"
},
"clicks" : {
"total" : 0 ,
"last_24h" : 0 ,
"suspicious" : 0 ,
"filtered" : 0 ,
"qr_scans" : 0
},
"safety" : {
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z"
},
"conversions" : {
"total" : 0 ,
"value" : 0
},
"etag" : "vsd7hv73x8s672m3" ,
"created_at" : "2026-11-03T10:23:30.000Z" ,
"updated_at" : "2026-11-03T10:23:30.000Z"
}
POST /v1/links/bulk
API key links:write
Each item is validated and created independently; the response lists a result per index.
Body
curl -X POST "https://api.cometly.site/v1/links/bulk" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"links": [
{
"url": "https://kesari.shop/a"
},
{
"url": "javascript:alert(1)"
}
]
}'const res = await fetch('https://api.cometly.site/v1/links/bulk', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"links": [
{
"url": "https://kesari.shop/a"
},
{
"url": "javascript:alert(1)"
}
]
}),
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/links/bulk",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"links": [
{
"url": "https://kesari.shop/a",
},
{
"url": "javascript:alert(1)",
},
],
},
)
print(res.json())200 application/json Copy
{
"results" : [
{
"index" : 0 ,
"ok" : true ,
"link" : {
"id" : "lnk_nzuj43fupycy" ,
"short_url" : "https://s.cometly.site/8uyuxe"
}
},
{
"index" : 1 ,
"ok" : false ,
"error" : {
"type" : "validation-error" ,
"title" : "Unprocessable Entity" ,
"status" : 422 ,
"detail" : "Request validation failed" ,
"errors" : [
{
"field" : "url" ,
"message" : "Only http and https URLs are allowed, not javascript"
}
]
}
}
],
"created" : 1 ,
"failed" : 1
}
GET /v1/links
API key links:read
Query parameters statusstring
active, expired, disabled or deleted (default: all but deleted)
domainstring
Only links on this hostname
tagstring
Only links with this tag
qstring
Search slug, title and destination
sortstring
created_at for oldest first (default newest first)
limitinteger
1–100, default 50
cursorstring
Opaque cursor from the previous page’s next_cursor
curl "https://api.cometly.site/v1/links?tag=instagram&limit=20" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links?tag=instagram&limit=20', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/links",
params={
"tag": "instagram",
"limit": "20",
},
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"data" : [
{
"id" : "lnk_594ufv74rqre" ,
"short_url" : "https://go.kesari.shop/diwali" ,
"qr_url" : "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" ,
"domain" : "go.kesari.shop" ,
"slug" : "diwali" ,
"destination" : "https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26" ,
"title" : "Diwali sale" ,
"tags" : [
"instagram"
],
"utm" : {
"source" : "instagram" ,
"medium" : "paid" ,
"campaign" : "diwali26"
},
"preview" : null ,
"rules" : [
{
"if" : {
"device" : "ios"
},
"url" : "https://apps.apple.com/in/app/kesari/id123"
}
],
"has_password" : false ,
"expires_at" : null ,
"max_clicks" : null ,
"status" : "active" ,
"disabled_reason" : null ,
"metadata" : {},
"type" : "url" ,
"deep_link" : {
"mode" : "off"
},
"ab_test" : null ,
"conversion_tracking" : true ,
"fallback_url" : "https://kesari.shop/" ,
"health" : {
"state" : "unknown"
},
"clicks" : {
"total" : 0 ,
"last_24h" : 0 ,
"suspicious" : 0 ,
"filtered" : 0 ,
"qr_scans" : 0
},
"safety" : {
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z"
},
"conversions" : {
"total" : 0 ,
"value" : 0
},
"etag" : "vsd7hv73x8s672m3" ,
"created_at" : "2026-11-03T10:23:30.000Z" ,
"updated_at" : "2026-11-03T10:23:30.000Z"
}
],
"next_cursor" : "MjAyNi0xMS0wM1QxMDoyMzozMC4wMDBafGxua181OTR1Znw"
}
GET /v1/links/by-url
API key links:read
Query parameters
curl "https://api.cometly.site/v1/links/by-url?short_url=https%3A%2F%2Fgo.kesari.shop%2Fdiwali" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/by-url?short_url=https%3A%2F%2Fgo.kesari.shop%2Fdiwali', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/links/by-url",
params={
"short_url": "https://go.kesari.shop/diwali",
},
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"id" : "lnk_594ufv74rqre" ,
"short_url" : "https://go.kesari.shop/diwali" ,
"qr_url" : "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" ,
"domain" : "go.kesari.shop" ,
"slug" : "diwali" ,
"destination" : "https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26" ,
"title" : "Diwali sale" ,
"tags" : [
"instagram"
],
"utm" : {
"source" : "instagram" ,
"medium" : "paid" ,
"campaign" : "diwali26"
},
"preview" : null ,
"rules" : [
{
"if" : {
"device" : "ios"
},
"url" : "https://apps.apple.com/in/app/kesari/id123"
}
],
"has_password" : false ,
"expires_at" : null ,
"max_clicks" : null ,
"status" : "active" ,
"disabled_reason" : null ,
"metadata" : {},
"type" : "url" ,
"deep_link" : {
"mode" : "off"
},
"ab_test" : null ,
"conversion_tracking" : true ,
"fallback_url" : "https://kesari.shop/" ,
"health" : {
"state" : "unknown"
},
"clicks" : {
"total" : 0 ,
"last_24h" : 0 ,
"suspicious" : 0 ,
"filtered" : 0 ,
"qr_scans" : 0
},
"safety" : {
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z"
},
"conversions" : {
"total" : 0 ,
"value" : 0
},
"etag" : "vsd7hv73x8s672m3" ,
"created_at" : "2026-11-03T10:23:30.000Z" ,
"updated_at" : "2026-11-03T10:23:30.000Z"
}
GET /v1/links/:id
API key links:read
Path parameters
curl "https://api.cometly.site/v1/links/lnk_594ufv74rqre" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"id" : "lnk_594ufv74rqre" ,
"short_url" : "https://go.kesari.shop/diwali" ,
"qr_url" : "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" ,
"domain" : "go.kesari.shop" ,
"slug" : "diwali" ,
"destination" : "https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26" ,
"title" : "Diwali sale" ,
"tags" : [
"instagram"
],
"utm" : {
"source" : "instagram" ,
"medium" : "paid" ,
"campaign" : "diwali26"
},
"preview" : null ,
"rules" : [
{
"if" : {
"device" : "ios"
},
"url" : "https://apps.apple.com/in/app/kesari/id123"
}
],
"has_password" : false ,
"expires_at" : null ,
"max_clicks" : null ,
"status" : "active" ,
"disabled_reason" : null ,
"metadata" : {},
"type" : "url" ,
"deep_link" : {
"mode" : "off"
},
"ab_test" : null ,
"conversion_tracking" : true ,
"fallback_url" : "https://kesari.shop/" ,
"health" : {
"state" : "unknown"
},
"clicks" : {
"total" : 0 ,
"last_24h" : 0 ,
"suspicious" : 0 ,
"filtered" : 0 ,
"qr_scans" : 0
},
"safety" : {
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z"
},
"conversions" : {
"total" : 0 ,
"value" : 0
},
"etag" : "vsd7hv73x8s672m3" ,
"created_at" : "2026-11-03T10:23:30.000Z" ,
"updated_at" : "2026-11-03T10:23:30.000Z"
}
PATCH /v1/links/:id
API key links:write
Send only the fields to change. Use If-Match: "<etag>" to avoid overwriting someone else’s edit (412 on mismatch). Changing the slug quarantines the old one for 30 days.
Path parameters Headers Body urlstring
Destination (http/https). Required unless builder is used. UTM fields are merged into it.
slugstring
1–60 chars a-z 0-9 - _, case-insensitive. Omit for a generated one.
titlestring
Up to 200 chars, for your own reference.
tagsstring[]
Up to 20 tags of ≤ 50 chars.
utmobject
{source, medium, campaign, term, content} added to the destination and rule URLs.
rulesobject[]
Up to 20 {if: {device|country|language|city}, url}; first match wins. Devices: ios, android, mobile, desktop.
deep_linkobject
{mode: "auto"|"custom"|"off", ios_url, android_package, escape_in_app} — open the app instead of the browser.
ab_testobject
{variants: [{url, weight}…2–4], ends_at, auto_winner, threshold}. The first variant is the control; weights sum to 100.
conversion_trackingboolean
Adds cmt_id=<click id> to the destination so you can report conversions.
fallback_urlstring
Served automatically while the destination is down.
previewobject
{title, description, image_url} shown by WhatsApp/Facebook/LinkedIn crawlers.
passwordstring
4–128 chars; visitors must enter it.
expires_atstring (date-time)
Link stops working after this time.
max_clicksinteger
Link stops after this many clicks.
metadataobject
Your own JSON (≤ 4 KB), returned and sent in webhooks.
Errors 412 etag-mismatchThe link changed since you read it
curl -X PATCH "https://api.cometly.site/v1/links/lnk_594ufv74rqre" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "If-Match: \"vsd7hv73x8s672m3\"" \
-H "Content-Type: application/json" \
-d '{
"title": "Diwali sale – Instagram",
"expires_at": "2026-11-15T23:59:00+05:30"
}'const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
'If-Match': '"vsd7hv73x8s672m3"',
},
body: JSON.stringify({
"title": "Diwali sale – Instagram",
"expires_at": "2026-11-15T23:59:00+05:30"
}),
});
const data = await res.json();import os, requests
res = requests.patch(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} ", "If-Match": "\"vsd7hv73x8s672m3\""},
json={
"title": "Diwali sale – Instagram",
"expires_at": "2026-11-15T23:59:00+05:30",
},
)
print(res.json())200 application/json Copy
{
"id" : "lnk_594ufv74rqre" ,
"short_url" : "https://go.kesari.shop/diwali" ,
"qr_url" : "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" ,
"domain" : "go.kesari.shop" ,
"slug" : "diwali" ,
"destination" : "https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26" ,
"title" : "Diwali sale – Instagram" ,
"tags" : [
"instagram"
],
"utm" : {
"source" : "instagram" ,
"medium" : "paid" ,
"campaign" : "diwali26"
},
"preview" : null ,
"rules" : [
{
"if" : {
"device" : "ios"
},
"url" : "https://apps.apple.com/in/app/kesari/id123"
}
],
"has_password" : false ,
"expires_at" : null ,
"max_clicks" : null ,
"status" : "active" ,
"disabled_reason" : null ,
"metadata" : {},
"type" : "url" ,
"deep_link" : {
"mode" : "off"
},
"ab_test" : null ,
"conversion_tracking" : true ,
"fallback_url" : "https://kesari.shop/" ,
"health" : {
"state" : "unknown"
},
"clicks" : {
"total" : 0 ,
"last_24h" : 0 ,
"suspicious" : 0 ,
"filtered" : 0 ,
"qr_scans" : 0
},
"safety" : {
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z"
},
"conversions" : {
"total" : 0 ,
"value" : 0
},
"etag" : "vsd7hv73x8s672m3" ,
"created_at" : "2026-11-03T10:23:30.000Z" ,
"updated_at" : "2026-11-03T10:23:30.000Z"
}
POST /v1/links/:id /disable
API key links:write
Path parameters
curl -X POST "https://api.cometly.site/v1/links/lnk_594ufv74rqre/disable" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/disable', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/disable",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"id" : "lnk_594ufv74rqre" ,
"short_url" : "https://go.kesari.shop/diwali" ,
"qr_url" : "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" ,
"domain" : "go.kesari.shop" ,
"slug" : "diwali" ,
"destination" : "https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26" ,
"title" : "Diwali sale" ,
"tags" : [
"instagram"
],
"utm" : {
"source" : "instagram" ,
"medium" : "paid" ,
"campaign" : "diwali26"
},
"preview" : null ,
"rules" : [
{
"if" : {
"device" : "ios"
},
"url" : "https://apps.apple.com/in/app/kesari/id123"
}
],
"has_password" : false ,
"expires_at" : null ,
"max_clicks" : null ,
"status" : "disabled" ,
"disabled_reason" : "user" ,
"metadata" : {},
"type" : "url" ,
"deep_link" : {
"mode" : "off"
},
"ab_test" : null ,
"conversion_tracking" : true ,
"fallback_url" : "https://kesari.shop/" ,
"health" : {
"state" : "unknown"
},
"clicks" : {
"total" : 0 ,
"last_24h" : 0 ,
"suspicious" : 0 ,
"filtered" : 0 ,
"qr_scans" : 0
},
"safety" : {
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z"
},
"conversions" : {
"total" : 0 ,
"value" : 0
},
"etag" : "vsd7hv73x8s672m3" ,
"created_at" : "2026-11-03T10:23:30.000Z" ,
"updated_at" : "2026-11-03T10:23:30.000Z"
}
POST /v1/links/:id /enable
API key links:write
Path parameters Errors 409 link-lockedDisabled for abuse or domain deletion
curl -X POST "https://api.cometly.site/v1/links/lnk_594ufv74rqre/enable" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/enable', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/enable",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"id" : "lnk_594ufv74rqre" ,
"short_url" : "https://go.kesari.shop/diwali" ,
"qr_url" : "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" ,
"domain" : "go.kesari.shop" ,
"slug" : "diwali" ,
"destination" : "https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26" ,
"title" : "Diwali sale" ,
"tags" : [
"instagram"
],
"utm" : {
"source" : "instagram" ,
"medium" : "paid" ,
"campaign" : "diwali26"
},
"preview" : null ,
"rules" : [
{
"if" : {
"device" : "ios"
},
"url" : "https://apps.apple.com/in/app/kesari/id123"
}
],
"has_password" : false ,
"expires_at" : null ,
"max_clicks" : null ,
"status" : "active" ,
"disabled_reason" : null ,
"metadata" : {},
"type" : "url" ,
"deep_link" : {
"mode" : "off"
},
"ab_test" : null ,
"conversion_tracking" : true ,
"fallback_url" : "https://kesari.shop/" ,
"health" : {
"state" : "unknown"
},
"clicks" : {
"total" : 0 ,
"last_24h" : 0 ,
"suspicious" : 0 ,
"filtered" : 0 ,
"qr_scans" : 0
},
"safety" : {
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z"
},
"conversions" : {
"total" : 0 ,
"value" : 0
},
"etag" : "vsd7hv73x8s672m3" ,
"created_at" : "2026-11-03T10:23:30.000Z" ,
"updated_at" : "2026-11-03T10:23:30.000Z"
}
DELETE /v1/links/:id
API key links:delete
Soft delete: the link stops redirecting and can be restored for 30 days. purge=true deletes it permanently now.
Path parameters Query parameters purgeboolean
Delete permanently
curl -X DELETE "https://api.cometly.site/v1/links/lnk_594ufv74rqre" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.delete(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())202 application/json Copy
{
"id" : "lnk_594ufv74rqre" ,
"short_url" : "https://go.kesari.shop/diwali" ,
"qr_url" : "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" ,
"domain" : "go.kesari.shop" ,
"slug" : "diwali" ,
"destination" : "https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26" ,
"title" : "Diwali sale" ,
"tags" : [
"instagram"
],
"utm" : {
"source" : "instagram" ,
"medium" : "paid" ,
"campaign" : "diwali26"
},
"preview" : null ,
"rules" : [
{
"if" : {
"device" : "ios"
},
"url" : "https://apps.apple.com/in/app/kesari/id123"
}
],
"has_password" : false ,
"expires_at" : null ,
"max_clicks" : null ,
"status" : "deleted" ,
"disabled_reason" : null ,
"metadata" : {},
"type" : "url" ,
"deep_link" : {
"mode" : "off"
},
"ab_test" : null ,
"conversion_tracking" : true ,
"fallback_url" : "https://kesari.shop/" ,
"health" : {
"state" : "unknown"
},
"clicks" : {
"total" : 0 ,
"last_24h" : 0 ,
"suspicious" : 0 ,
"filtered" : 0 ,
"qr_scans" : 0
},
"safety" : {
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z"
},
"conversions" : {
"total" : 0 ,
"value" : 0
},
"etag" : "vsd7hv73x8s672m3" ,
"created_at" : "2026-11-03T10:23:30.000Z" ,
"updated_at" : "2026-11-03T10:23:30.000Z" ,
"deleted_at" : "2026-11-03T10:30:00.000Z" ,
"purge_at" : "2026-12-03T10:30:00.000Z"
}
POST /v1/links/:id /restore
API key links:write
Path parameters
curl -X POST "https://api.cometly.site/v1/links/lnk_594ufv74rqre/restore" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/restore', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/restore",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"id" : "lnk_594ufv74rqre" ,
"short_url" : "https://go.kesari.shop/diwali" ,
"qr_url" : "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" ,
"domain" : "go.kesari.shop" ,
"slug" : "diwali" ,
"destination" : "https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26" ,
"title" : "Diwali sale" ,
"tags" : [
"instagram"
],
"utm" : {
"source" : "instagram" ,
"medium" : "paid" ,
"campaign" : "diwali26"
},
"preview" : null ,
"rules" : [
{
"if" : {
"device" : "ios"
},
"url" : "https://apps.apple.com/in/app/kesari/id123"
}
],
"has_password" : false ,
"expires_at" : null ,
"max_clicks" : null ,
"status" : "active" ,
"disabled_reason" : null ,
"metadata" : {},
"type" : "url" ,
"deep_link" : {
"mode" : "off"
},
"ab_test" : null ,
"conversion_tracking" : true ,
"fallback_url" : "https://kesari.shop/" ,
"health" : {
"state" : "unknown"
},
"clicks" : {
"total" : 0 ,
"last_24h" : 0 ,
"suspicious" : 0 ,
"filtered" : 0 ,
"qr_scans" : 0
},
"safety" : {
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z"
},
"conversions" : {
"total" : 0 ,
"value" : 0
},
"etag" : "vsd7hv73x8s672m3" ,
"created_at" : "2026-11-03T10:23:30.000Z" ,
"updated_at" : "2026-11-03T10:23:30.000Z"
}
POST /v1/slug-quarantine/release
API key links:write
Body domainstring required
Hostname
slugstring required
The slug to free
curl -X POST "https://api.cometly.site/v1/slug-quarantine/release" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"domain": "go.kesari.shop",
"slug": "old-offer"
}'const res = await fetch('https://api.cometly.site/v1/slug-quarantine/release', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"domain": "go.kesari.shop",
"slug": "old-offer"
}),
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/slug-quarantine/release",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"domain": "go.kesari.shop",
"slug": "old-offer",
},
)
print(res.json())200 application/json Copy
{
"released" : true ,
"domain" : "go.kesari.shop" ,
"slug" : "old-offer"
}
Link builders & deep links Build WhatsApp, UPI, Google Maps, Telegram and app-store links from plain fields, and see which apps open automatically.
POST /v1/builders/:type
API key links:write
Returns the built URL and a ready link_request to POST to /v1/links. Fields by type — whatsapp : phone, text, country (default IN). upi : pa (VPA), pn (payee), am, tn, tr, mc. maps : mode (search|directions|review), query, place_id. telegram : username, start. app : ios_url, android_url, web_url.
Path parameters
curl -X POST "https://api.cometly.site/v1/builders/whatsapp" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"phone": "098765 43210",
"text": "Hi! I saw your Diwali offer"
}'const res = await fetch('https://api.cometly.site/v1/builders/whatsapp', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"phone": "098765 43210",
"text": "Hi! I saw your Diwali offer"
}),
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/builders/whatsapp",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"phone": "098765 43210",
"text": "Hi! I saw your Diwali offer",
},
)
print(res.json())200 application/json Copy
{
"url" : "https://wa.me/919876543210?text=Hi!%20I%20saw%20your%20Diwali%20offer" ,
"link_type" : "url" ,
"warnings" : [],
"summary" : "WhatsApp chat with +919876543210" ,
"link_request" : {
"builder" : {
"type" : "whatsapp" ,
"phone" : "098765 43210" ,
"text" : "Hi! I saw your Diwali offer"
}
}
}
GET /v1/deep-link/apps
API key links:read
curl "https://api.cometly.site/v1/deep-link/apps" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/deep-link/apps', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/deep-link/apps",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"data" : [
{
"id" : "youtube" ,
"name" : "YouTube" ,
"hosts" : [
"youtube.com" ,
"youtu.be"
],
"ios" : true ,
"android" : true
},
{
"id" : "instagram" ,
"name" : "Instagram" ,
"hosts" : [
"instagram.com"
],
"ios" : true ,
"android" : true
}
]
}
QR codes Branded QR codes for any link. Every saved design is rendered and decoded before it’s accepted, and scans are counted separately from clicks (clicks.qr_scans).
GET /v1/links/:id /qr
API key qr:read
SVG by default, or PNG. Uses the link’s saved design, else the workspace style; any style field can be overridden on the query string. The code encodes <short url>?qr=1 (header X-QR-Content). Supports If-None-Match.
Path parameters Query parameters formatstring
svg (default) or png
sizeinteger
Pixels, 64–4096 (default 600)
downloadboolean
Send as an attachment
fg bg corner_colorstring
Hex colours (1E1847 or #1E1847)
dotsstring
square, rounded, dots, classy
cornersstring
square, rounded, dot
corner_dotsstring
square, dot
margininteger
Quiet zone in modules, 0–10 (default 4)
eclstring
Error correction L|M|Q|H (forced to H with a logo)
logoboolean
0 to hide the workspace logo
Errors 422 validation-errorColours too close to scan (contrast < 3:1)
curl "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr?format=png&size=1024" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-o qr.pngconst res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr?format=png&size=1024', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const bytes = new Uint8Array(await res.arrayBuffer()); // PNGimport os, requests
res = requests.get(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr",
params={
"format": "png",
"size": "1024",
},
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
open("qr.png", "wb").write(res.content)200 image/svg+xml Copy
SVG or PNG image bytes
PUT /v1/links/:id /qr
API key links:write
The design is rendered and decoded with a QR reader first; if it doesn’t return the exact URL it’s rejected. Send {"reset": true} to go back to the workspace style.
Path parameters Body Errors 422 qr-not-scannableA reader couldn’t decode the rendered design
curl -X PUT "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"dots": "rounded",
"corners": "dot",
"corner_dots": "dot",
"fg": "#1E1847",
"corner_color": "#E8572A"
}'const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"dots": "rounded",
"corners": "dot",
"corner_dots": "dot",
"fg": "#1E1847",
"corner_color": "#E8572A"
}),
});
const data = await res.json();import os, requests
res = requests.put(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"dots": "rounded",
"corners": "dot",
"corner_dots": "dot",
"fg": "#1E1847",
"corner_color": "#E8572A",
},
)
print(res.json())200 application/json Copy
{
"style" : {
"fg" : "#1E1847" ,
"bg" : "#FFFFFF" ,
"dots" : "rounded" ,
"corners" : "dot" ,
"corner_dots" : "dot" ,
"corner_color" : "#E8572A" ,
"margin" : 4 ,
"ecl" : "M" ,
"logo" : true ,
"logo_size" : 0.22
},
"inherited" : false ,
"warnings" : [],
"scannable" : true ,
"version" : 4 ,
"error_correction" : "M"
}
GET /v1/qr/settings
API key qr:read
curl "https://api.cometly.site/v1/qr/settings" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/qr/settings', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/qr/settings",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"style" : {
"fg" : "#1E1847" ,
"bg" : "#FFFFFF" ,
"dots" : "square" ,
"corners" : "square" ,
"corner_dots" : "square" ,
"margin" : 4 ,
"ecl" : "M" ,
"logo" : true ,
"logo_size" : 0.22
},
"has_logo" : true ,
"logo_sha256" : "9c1f…"
}
PUT /v1/qr/settings
API key links:write
Logo: a PNG, JPEG or WebP data URI up to 512 KB (SVG refused). It’s re-encoded to ≤ 512 px. logo: null removes it.
Body
curl -X PUT "https://api.cometly.site/v1/qr/settings" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"style": {
"fg": "#1E1847",
"corners": "rounded"
},
"logo": "data:image/png;base64,iVBORw0KGgo…"
}'const res = await fetch('https://api.cometly.site/v1/qr/settings', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"style": {
"fg": "#1E1847",
"corners": "rounded"
},
"logo": "data:image/png;base64,iVBORw0KGgo…"
}),
});
const data = await res.json();import os, requests
res = requests.put(
"https://api.cometly.site/v1/qr/settings",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"style": {
"fg": "#1E1847",
"corners": "rounded",
},
"logo": "data:image/png;base64,iVBORw0KGgo…",
},
)
print(res.json())200 application/json Copy
{
"style" : {
"fg" : "#1E1847" ,
"bg" : "#FFFFFF" ,
"dots" : "square" ,
"corners" : "rounded" ,
"corner_dots" : "square" ,
"margin" : 4 ,
"ecl" : "M" ,
"logo" : true ,
"logo_size" : 0.22
},
"has_logo" : true ,
"logo_sha256" : "9c1f…" ,
"warnings" : []
}
A/B tests Split traffic between destinations and pick a winner on conversions (Bayesian chance to win, with a sample-ratio check).
GET /v1/links/:id /ab-results
API key links:read
Path parameters
curl "https://api.cometly.site/v1/links/lnk_594ufv74rqre/ab-results" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/ab-results', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/ab-results",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"link_id" : "lnk_an2khheekdnb" ,
"status" : "running" ,
"started_at" : "2026-11-01T10:02:10.000Z" ,
"ends_at" : null ,
"winner_id" : null ,
"threshold" : 0.95 ,
"variants" : [
{
"id" : "a" ,
"url" : "https://kesari.shop/v1" ,
"weight" : 50 ,
"clicks" : 9210 ,
"conversions" : 412 ,
"revenue" : 0 ,
"rate" : 0.0447 ,
"uplift" : null ,
"ci95" : null ,
"chance_to_win" : 0.01
},
{
"id" : "b" ,
"url" : "https://kesari.shop/v2" ,
"weight" : 50 ,
"clicks" : 9222 ,
"conversions" : 503 ,
"revenue" : 0 ,
"rate" : 0.0545 ,
"uplift" : 0.219 ,
"ci95" : [
0.08 ,
0.36
],
"chance_to_win" : 0.99
}
],
"srm" : {
"p_value" : 0.93 ,
"warning" : false
},
"recommendation" : {
"done" : true ,
"winner" : "b" ,
"reason" : "Variant b has a 99 % chance to beat the control."
},
"method" : "Bayesian chance to win on relative uplift (flat prior, delta-method SE), with SRM check"
}
POST /v1/links/:id /ab-test/complete
API key links:write
Path parameters Body winner_idstring required
Variant id, e.g. b
curl -X POST "https://api.cometly.site/v1/links/lnk_594ufv74rqre/ab-test/complete" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"winner_id": "b"
}'const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/ab-test/complete', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"winner_id": "b"
}),
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/ab-test/complete",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"winner_id": "b",
},
)
print(res.json())200 application/json Copy
{
"id" : "lnk_594ufv74rqre" ,
"short_url" : "https://go.kesari.shop/diwali" ,
"qr_url" : "https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr" ,
"domain" : "go.kesari.shop" ,
"slug" : "diwali" ,
"destination" : "https://kesari.shop/v2" ,
"title" : "Diwali sale" ,
"tags" : [
"instagram"
],
"utm" : {
"source" : "instagram" ,
"medium" : "paid" ,
"campaign" : "diwali26"
},
"preview" : null ,
"rules" : [
{
"if" : {
"device" : "ios"
},
"url" : "https://apps.apple.com/in/app/kesari/id123"
}
],
"has_password" : false ,
"expires_at" : null ,
"max_clicks" : null ,
"status" : "active" ,
"disabled_reason" : null ,
"metadata" : {},
"type" : "url" ,
"deep_link" : {
"mode" : "off"
},
"ab_test" : null ,
"conversion_tracking" : true ,
"fallback_url" : "https://kesari.shop/" ,
"health" : {
"state" : "unknown"
},
"clicks" : {
"total" : 0 ,
"last_24h" : 0 ,
"suspicious" : 0 ,
"filtered" : 0 ,
"qr_scans" : 0
},
"safety" : {
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z"
},
"conversions" : {
"total" : 0 ,
"value" : 0
},
"etag" : "vsd7hv73x8s672m3" ,
"created_at" : "2026-11-03T10:23:30.000Z" ,
"updated_at" : "2026-11-03T10:23:30.000Z"
}
Link health & traffic quality Broken-destination monitoring and the bot/fraud breakdown of a link’s clicks.
GET /v1/links/:id /health
API key links:read
Path parameters
curl "https://api.cometly.site/v1/links/lnk_594ufv74rqre/health" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/health', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/health",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"link_id" : "lnk_594ufv74rqre" ,
"health" : {
"state" : "up" ,
"destination_down" : false ,
"last_checked_at" : "2026-11-03T10:30:00.000Z"
},
"next_check_at" : "2026-11-03T11:00:00.000Z" ,
"fallback_url" : "https://kesari.shop/" ,
"recent_checks" : [
{
"url" : "https://kesari.shop/diwali" ,
"outcome" : "up" ,
"status_code" : 200 ,
"checked_at" : "2026-11-03T10:30:00.000Z"
}
]
}
POST /v1/links/:id /health/check
API key links:write
Path parameters
curl -X POST "https://api.cometly.site/v1/links/lnk_594ufv74rqre/health/check" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/health/check', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/health/check",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"link_id" : "lnk_594ufv74rqre" ,
"health" : {
"state" : "up" ,
"destination_down" : false
}
}
GET /v1/links/:id /traffic-quality
API key stats:read
Path parameters Query parameters daysinteger
1–90, default 30
curl "https://api.cometly.site/v1/links/lnk_594ufv74rqre/traffic-quality?days=7" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/traffic-quality?days=7', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/traffic-quality",
params={
"days": "7",
},
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"link_id" : "lnk_594ufv74rqre" ,
"days" : 30 ,
"counts" : {
"valid" : 41210 ,
"suspicious" : 1874 ,
"invalid" : 963 ,
"bot" : 2402
},
"total" : 46449 ,
"counted_clicks" : 43084 ,
"filtered_share" : 0.072 ,
"top_reasons" : [
{
"reason" : "bot_user_agent" ,
"count" : 1310
},
{
"reason" : "datacenter_ip" ,
"count" : 611
}
]
}
Link safety Every destination and redirect hop is checked against phishing/malware feeds, Google Safe Browsing and heuristics. Malicious destinations are refused (422 destination-blocked) or disabled.
GET /v1/links/:id /safety
API key links:read
Path parameters
curl "https://api.cometly.site/v1/links/lnk_594ufv74rqre/safety" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/safety', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/safety",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"verdict" : "clean" ,
"review" : null ,
"reasons" : [],
"checked_at" : "2026-11-03T10:02:10.000Z" ,
"chain" : [
"https://kesari.shop/diwali"
]
}
POST /v1/links/:id /safety/check
API key links:write
Path parameters
curl -X POST "https://api.cometly.site/v1/links/lnk_594ufv74rqre/safety/check" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/links/lnk_594ufv74rqre/safety/check', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/links/lnk_594ufv74rqre/safety/check",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"verdict" : "malicious" ,
"review" : "blocked" ,
"reasons" : [
"Listed by openphish as phishing (host phish.example)"
],
"checked_at" : "2026-11-03T10:40:00.000Z" ,
"chain" : [
"https://bit.ly/3x" ,
"https://phish.example/login"
],
"status" : "disabled"
}
Conversions & integrations Report leads and sales against a click (cmt_id) and forward them to Meta Conversions API and GA4.
POST /v1/conversions
API key conversions:write
Send the cmt_id your landing page received as click_id (or set external_id to attribute repeat purchases to the customer’s first click). event_id makes it idempotent (a repeat returns the first conversion with 200) and is passed to Meta for deduplication.
Body click_idstring
clk_… from the cmt_id URL parameter
eventstring required
lead, sale or a custom name
valuenumber
Order value
currencystring
ISO 4217, e.g. INR
event_idstring
Your order/lead id (dedupe)
external_idstring
Your customer id
occurred_atstring (date-time)
Default now
user_dataobject
{email, phone, client_ip_address, client_user_agent, fbp, ga_client_id} — hashed before forwarding
metadataobject
≤ 4 KB
Errors 404 click-not-foundUnknown click_id (clicks are kept 13 months)
curl -X POST "https://api.cometly.site/v1/conversions" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"click_id": "clk_7m2xq9kd4hfa8pne",
"event": "sale",
"value": 1499,
"currency": "INR",
"event_id": "order-1182",
"external_id": "cust_42",
"user_data": {
"email": "asha@example.com"
}
}'const res = await fetch('https://api.cometly.site/v1/conversions', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"click_id": "clk_7m2xq9kd4hfa8pne",
"event": "sale",
"value": 1499,
"currency": "INR",
"event_id": "order-1182",
"external_id": "cust_42",
"user_data": {
"email": "asha@example.com"
}
}),
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/conversions",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"click_id": "clk_7m2xq9kd4hfa8pne",
"event": "sale",
"value": 1499,
"currency": "INR",
"event_id": "order-1182",
"external_id": "cust_42",
"user_data": {
"email": "asha@example.com",
},
},
)
print(res.json())201 application/json Copy
{
"id" : "cnv_8hq2m5x7tz3c" ,
"link_id" : "lnk_594ufv74rqre" ,
"click_id" : "clk_7m2xq9kd4hfa8pne" ,
"variant_id" : null ,
"event_type" : "sale" ,
"event_name" : "sale" ,
"value" : 1499 ,
"currency" : "INR" ,
"event_id" : "order-1182" ,
"occurred_at" : "2026-11-03T10:45:00.000Z" ,
"forwarding" : {
"meta_capi" : "queued" ,
"ga4" : "queued"
}
}
GET /v1/conversions
API key conversions:read
Query parameters
curl "https://api.cometly.site/v1/conversions?link_id=lnk_594ufv74rqre&event=sale" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/conversions?link_id=lnk_594ufv74rqre&event=sale', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/conversions",
params={
"link_id": "lnk_594ufv74rqre",
"event": "sale",
},
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"data" : [
{
"id" : "cnv_8hq2m5x7tz3c" ,
"event_name" : "sale" ,
"value" : 1499 ,
"currency" : "INR" ,
"link_id" : "lnk_594ufv74rqre" ,
"occurred_at" : "2026-11-03T10:45:00.000Z"
}
]
}
GET /v1/integrations
API key account:read
curl "https://api.cometly.site/v1/integrations" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/integrations', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/integrations",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"data" : [
{
"kind" : "ga4" ,
"enabled" : true ,
"config" : {
"measurement_id" : "G-ABC1234"
},
"last_error" : null ,
"updated_at" : "2026-11-03T10:50:00.000Z"
}
]
}
PUT /v1/integrations/:kind
API key integrations:write
meta_capi : pixel_id, access_token, api_version, test_event_code, enabled. ga4 : measurement_id, api_secret, enabled. Secrets are encrypted and never returned.
Path parameters kindstring required
meta_capi or ga4
curl -X PUT "https://api.cometly.site/v1/integrations/ga4" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"measurement_id": "G-ABC1234",
"api_secret": "xxxxxxxxxxxx"
}'const res = await fetch('https://api.cometly.site/v1/integrations/ga4', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"measurement_id": "G-ABC1234",
"api_secret": "xxxxxxxxxxxx"
}),
});
const data = await res.json();import os, requests
res = requests.put(
"https://api.cometly.site/v1/integrations/ga4",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"measurement_id": "G-ABC1234",
"api_secret": "xxxxxxxxxxxx",
},
)
print(res.json())200 application/json Copy
{
"kind" : "ga4" ,
"enabled" : true ,
"config" : {
"measurement_id" : "G-ABC1234"
}
}
DELETE /v1/integrations/:kind
API key integrations:write
Path parameters kindstring required
meta_capi or ga4
curl -X DELETE "https://api.cometly.site/v1/integrations/ga4" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/integrations/ga4', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.delete(
"https://api.cometly.site/v1/integrations/ga4",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"deleted" : true
}
Domains Bring your own (sub)domain. Add it, create the DNS records shown, then verify. HTTPS is issued automatically.
POST /v1/domains
API key domains:write
Returns the DNS records to create: a TXT record proving ownership and a CNAME (subdomain) or A/AAAA (root domain) for routing.
Body hostnamestring required
e.g. go.yourbrand.com (Unicode allowed)
homepage_urlstring
Where the bare domain redirects
not_found_urlstring
Where unknown slugs redirect
Errors 409 domain-in-useConnected to another workspace 422 invalid-hostnameNot under a public suffix, reserved or a look-alike of a brand 402 domain-limit-reachedPlan limit
curl -X POST "https://api.cometly.site/v1/domains" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"hostname": "go.kesari.shop"
}'const res = await fetch('https://api.cometly.site/v1/domains', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"hostname": "go.kesari.shop"
}),
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/domains",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"hostname": "go.kesari.shop",
},
)
print(res.json())201 application/json Copy
{
"id" : "dom_kd292xv8n8tg" ,
"hostname" : "go.kesari.shop" ,
"hostname_unicode" : "go.kesari.shop" ,
"type" : "subdomain" ,
"status" : "pending_dns" ,
"is_default" : false ,
"dns_records" : [
{
"purpose" : "ownership" ,
"type" : "TXT" ,
"name" : "_cometly-verify.go.kesari.shop" ,
"value" : "cometly-verify=4b13de118bc0f44036cd" ,
"ttl" : 300 ,
"required" : true
},
{
"purpose" : "routing" ,
"type" : "CNAME" ,
"name" : "go.kesari.shop" ,
"value" : "edge.cometly.site" ,
"ttl" : 300 ,
"required" : true
}
],
"checks" : {
"ownership" : "pending" ,
"routing" : "pending" ,
"https" : "pending"
},
"notes" : [
"If you use Cloudflare, set the routing record to 'DNS only' (grey cloud)." ,
"If your domain has CAA records, allow letsencrypt.org."
],
"homepage_url" : null ,
"not_found_url" : null ,
"failure_reason" : null ,
"disabled_reason" : null ,
"verify_url" : "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify" ,
"last_checked_at" : null ,
"next_check_at" : "2026-11-03T10:00:00.000Z" ,
"verified_at" : null ,
"tls_issued_at" : null ,
"misconfigured_since" : null ,
"created_at" : "2026-11-03T10:00:00.000Z"
}
GET /v1/domains
API key domains:read
Query parameters statusstring
pending_dns, verifying, active, misconfigured, disabled, pending_deletion…
limitinteger
1–100, default 50
cursorstring
Opaque cursor from the previous page’s next_cursor
curl "https://api.cometly.site/v1/domains" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/domains', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/domains",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"data" : [
{
"id" : "dom_kd292xv8n8tg" ,
"hostname" : "go.kesari.shop" ,
"hostname_unicode" : "go.kesari.shop" ,
"type" : "subdomain" ,
"status" : "active" ,
"is_default" : false ,
"dns_records" : [
{
"purpose" : "ownership" ,
"type" : "TXT" ,
"name" : "_cometly-verify.go.kesari.shop" ,
"value" : "cometly-verify=4b13de118bc0f44036cd" ,
"ttl" : 300 ,
"required" : true
},
{
"purpose" : "routing" ,
"type" : "CNAME" ,
"name" : "go.kesari.shop" ,
"value" : "edge.cometly.site" ,
"ttl" : 300 ,
"required" : true
}
],
"checks" : {
"ownership" : "pending" ,
"routing" : "pending" ,
"https" : "pending"
},
"notes" : [
"If you use Cloudflare, set the routing record to 'DNS only' (grey cloud)." ,
"If your domain has CAA records, allow letsencrypt.org."
],
"homepage_url" : null ,
"not_found_url" : null ,
"failure_reason" : null ,
"disabled_reason" : null ,
"verify_url" : "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify" ,
"last_checked_at" : null ,
"next_check_at" : "2026-11-03T10:00:00.000Z" ,
"verified_at" : null ,
"tls_issued_at" : null ,
"misconfigured_since" : null ,
"created_at" : "2026-11-03T10:00:00.000Z"
}
],
"next_cursor" : null
}
GET /v1/domains/:id
API key domains:read
Path parameters idstring required
Domain ID
curl "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"id" : "dom_kd292xv8n8tg" ,
"hostname" : "go.kesari.shop" ,
"hostname_unicode" : "go.kesari.shop" ,
"type" : "subdomain" ,
"status" : "pending_dns" ,
"is_default" : false ,
"dns_records" : [
{
"purpose" : "ownership" ,
"type" : "TXT" ,
"name" : "_cometly-verify.go.kesari.shop" ,
"value" : "cometly-verify=4b13de118bc0f44036cd" ,
"ttl" : 300 ,
"required" : true
},
{
"purpose" : "routing" ,
"type" : "CNAME" ,
"name" : "go.kesari.shop" ,
"value" : "edge.cometly.site" ,
"ttl" : 300 ,
"required" : true
}
],
"checks" : {
"ownership" : "pending" ,
"routing" : "pending" ,
"https" : "pending"
},
"notes" : [
"If you use Cloudflare, set the routing record to 'DNS only' (grey cloud)." ,
"If your domain has CAA records, allow letsencrypt.org."
],
"homepage_url" : null ,
"not_found_url" : null ,
"failure_reason" : null ,
"disabled_reason" : null ,
"verify_url" : "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify" ,
"last_checked_at" : null ,
"next_check_at" : "2026-11-03T10:00:00.000Z" ,
"verified_at" : null ,
"tls_issued_at" : null ,
"misconfigured_since" : null ,
"created_at" : "2026-11-03T10:00:00.000Z"
}
PATCH /v1/domains/:id
API key domains:write
Path parameters idstring required
Domain ID
Body homepage_urlstring | null
Bare-domain redirect
not_found_urlstring | null
Unknown-slug redirect
is_defaultboolean
Make it the workspace default
curl -X PATCH "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"is_default": true,
"not_found_url": "https://kesari.shop/"
}'const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"is_default": true,
"not_found_url": "https://kesari.shop/"
}),
});
const data = await res.json();import os, requests
res = requests.patch(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"is_default": True,
"not_found_url": "https://kesari.shop/",
},
)
print(res.json())200 application/json Copy
{
"id" : "dom_kd292xv8n8tg" ,
"hostname" : "go.kesari.shop" ,
"hostname_unicode" : "go.kesari.shop" ,
"type" : "subdomain" ,
"status" : "active" ,
"is_default" : true ,
"dns_records" : [
{
"purpose" : "ownership" ,
"type" : "TXT" ,
"name" : "_cometly-verify.go.kesari.shop" ,
"value" : "cometly-verify=4b13de118bc0f44036cd" ,
"ttl" : 300 ,
"required" : true
},
{
"purpose" : "routing" ,
"type" : "CNAME" ,
"name" : "go.kesari.shop" ,
"value" : "edge.cometly.site" ,
"ttl" : 300 ,
"required" : true
}
],
"checks" : {
"ownership" : "pending" ,
"routing" : "pending" ,
"https" : "pending"
},
"notes" : [
"If you use Cloudflare, set the routing record to 'DNS only' (grey cloud)." ,
"If your domain has CAA records, allow letsencrypt.org."
],
"homepage_url" : null ,
"not_found_url" : "https://kesari.shop/" ,
"failure_reason" : null ,
"disabled_reason" : null ,
"verify_url" : "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify" ,
"last_checked_at" : null ,
"next_check_at" : "2026-11-03T10:00:00.000Z" ,
"verified_at" : null ,
"tls_issued_at" : null ,
"misconfigured_since" : null ,
"created_at" : "2026-11-03T10:00:00.000Z"
}
POST /v1/domains/:id /verify
API key domains:write
DNS is checked through two resolvers; a domain goes verifying on the first agreeing check and active once DNS still agrees ≥ 2 minutes later and HTTPS is live. Checks also run automatically.
Path parameters idstring required
Domain ID
curl -X POST "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"id" : "dom_kd292xv8n8tg" ,
"hostname" : "go.kesari.shop" ,
"hostname_unicode" : "go.kesari.shop" ,
"type" : "subdomain" ,
"status" : "active" ,
"is_default" : false ,
"dns_records" : [
{
"purpose" : "ownership" ,
"type" : "TXT" ,
"name" : "_cometly-verify.go.kesari.shop" ,
"value" : "cometly-verify=4b13de118bc0f44036cd" ,
"ttl" : 300 ,
"required" : true
},
{
"purpose" : "routing" ,
"type" : "CNAME" ,
"name" : "go.kesari.shop" ,
"value" : "edge.cometly.site" ,
"ttl" : 300 ,
"required" : true
}
],
"checks" : {
"ownership" : "ok" ,
"routing" : "ok" ,
"https" : "ok" ,
"caa" : "ok"
},
"notes" : [
"If you use Cloudflare, set the routing record to 'DNS only' (grey cloud)." ,
"If your domain has CAA records, allow letsencrypt.org."
],
"homepage_url" : null ,
"not_found_url" : null ,
"failure_reason" : null ,
"disabled_reason" : null ,
"verify_url" : "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify" ,
"last_checked_at" : null ,
"next_check_at" : "2026-11-03T10:00:00.000Z" ,
"verified_at" : null ,
"tls_issued_at" : null ,
"misconfigured_since" : null ,
"created_at" : "2026-11-03T10:00:00.000Z"
}
GET /v1/domains/:id /dns-instructions
API key domains:read
Path parameters idstring required
Domain ID
Query parameters providerstring
cloudflare, godaddy, namecheap, hostinger, google, route53
curl "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/dns-instructions?provider=cloudflare" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/dns-instructions?provider=cloudflare', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/dns-instructions",
params={
"provider": "cloudflare",
},
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"domain_id" : "dom_kd292xv8n8tg" ,
"hostname" : "go.kesari.shop" ,
"provider" : "cloudflare" ,
"provider_name" : "Cloudflare" ,
"supported_providers" : [
"cloudflare" ,
"godaddy" ,
"namecheap" ,
"hostinger" ,
"google" ,
"route53"
],
"steps" : [
"Open dash.cloudflare.com, pick the domain, then go to DNS → Records."
],
"records" : [
{
"purpose" : "ownership" ,
"type" : "TXT" ,
"name" : "_cometly-verify.go.kesari.shop" ,
"value" : "cometly-verify=4b13de118bc0f44036cd" ,
"ttl" : 300 ,
"required" : true
},
{
"purpose" : "routing" ,
"type" : "CNAME" ,
"name" : "go.kesari.shop" ,
"value" : "edge.cometly.site" ,
"ttl" : 300 ,
"required" : true
}
],
"notes" : [
"If you use Cloudflare, set the routing record to 'DNS only' (grey cloud)." ,
"If your domain has CAA records, allow letsencrypt.org."
]
}
GET /v1/domains/:id /health
API key domains:read
Path parameters idstring required
Domain ID
curl "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/health" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/health', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/health",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"domain_id" : "dom_kd292xv8n8tg" ,
"hostname" : "go.kesari.shop" ,
"status" : "active" ,
"last_check" : {
"checked_at" : "2026-11-03T10:02:10.000Z" ,
"ownership_ok" : true ,
"routing_ok" : true ,
"https_ok" : true ,
"caa_ok" : true ,
"proxied" : false
},
"certificate" : {
"issued_at" : "2026-11-03T10:02:10.000Z"
},
"reputation" : {
"status" : "ok" ,
"checked_at" : "2026-11-03T10:05:00.000Z" ,
"details" : "/v1/domains/dom_kd292xv8n8tg/reputation"
}
}
GET /v1/domains/:id /deletion-preview
API key domains:read
Path parameters idstring required
Domain ID
curl "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/deletion-preview" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/deletion-preview', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/deletion-preview",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"domain_id" : "dom_kd292xv8n8tg" ,
"hostname" : "go.kesari.shop" ,
"status" : "active" ,
"link_count" : 128 ,
"clicks_last_30_days" : 18432 ,
"is_default" : true ,
"api_keys_limited_to_domain" : [],
"on_links_options" : [
"disable" ,
"move" ,
"delete"
],
"restore_window_days" : 7
}
DELETE /v1/domains/:id
API key domains:delete
Choose what happens to its links. Restorable for 7 days. Domains with links need X-Confirm-Hostname. Returns a job to poll.
Path parameters idstring required
Domain ID
Query parameters on_linksstring required
disable, move or delete
move_tostring
Target domain hostname for move
on_conflictstring
fail (default) or suffix (adds -2, -3)
purgeboolean
Skip the 7-day restore window
Headers
curl -X DELETE "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg?on_links=move&move_to=go2.kesari.shop" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "X-Confirm-Hostname: go.kesari.shop"const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg?on_links=move&move_to=go2.kesari.shop', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'X-Confirm-Hostname': 'go.kesari.shop',
},
});
const data = await res.json();import os, requests
res = requests.delete(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg",
params={
"on_links": "move",
"move_to": "go2.kesari.shop",
},
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} ", "X-Confirm-Hostname": "go.kesari.shop"},
)
print(res.json())202 application/json Copy
{
"id" : "dom_kd292xv8n8tg" ,
"status" : "pending_deletion" ,
"job" : {
"id" : "job_q8m2x7" ,
"status" : "queued" ,
"url" : "/v1/jobs/job_q8m2x7"
},
"purge_at" : "2026-11-10T10:00:00.000Z"
}
POST /v1/domains/:id /restore
API key domains:write
Path parameters idstring required
Domain ID
curl -X POST "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/restore" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/restore', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/restore",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"id" : "dom_kd292xv8n8tg" ,
"hostname" : "go.kesari.shop" ,
"hostname_unicode" : "go.kesari.shop" ,
"type" : "subdomain" ,
"status" : "active" ,
"is_default" : false ,
"dns_records" : [
{
"purpose" : "ownership" ,
"type" : "TXT" ,
"name" : "_cometly-verify.go.kesari.shop" ,
"value" : "cometly-verify=4b13de118bc0f44036cd" ,
"ttl" : 300 ,
"required" : true
},
{
"purpose" : "routing" ,
"type" : "CNAME" ,
"name" : "go.kesari.shop" ,
"value" : "edge.cometly.site" ,
"ttl" : 300 ,
"required" : true
}
],
"checks" : {
"ownership" : "pending" ,
"routing" : "pending" ,
"https" : "pending"
},
"notes" : [
"If you use Cloudflare, set the routing record to 'DNS only' (grey cloud)." ,
"If your domain has CAA records, allow letsencrypt.org."
],
"homepage_url" : null ,
"not_found_url" : null ,
"failure_reason" : null ,
"disabled_reason" : null ,
"verify_url" : "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify" ,
"last_checked_at" : null ,
"next_check_at" : "2026-11-03T10:00:00.000Z" ,
"verified_at" : null ,
"tls_issued_at" : null ,
"misconfigured_since" : null ,
"created_at" : "2026-11-03T10:00:00.000Z"
}
POST /v1/domains/:id /cancel
API key domains:delete
Path parameters idstring required
Domain ID
curl -X POST "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/cancel" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/cancel",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"id" : "dom_kd292xv8n8tg" ,
"status" : "deleted"
}
Domain reputation Is your short domain blocked on Facebook/Instagram, by Chrome/Gmail, on email blocklists or by security vendors? Checked daily and on demand.
GET /v1/domains/:id /reputation
API key domains:read
Checks: meta (Facebook, Messenger, Instagram), safe_browsing (Chrome/Safari/Gmail), spamhaus_dbl, surbl, uribl, virustotal, urlhaus, local_feeds, own_abuse, domain_age, tls. Status per check: ok, warning, listed, error (couldn’t check), skipped (not configured). Platforms without an API are listed under manual_checks.
Path parameters idstring required
Domain ID
curl "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/reputation" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/reputation', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/reputation",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"domain" : "go.kesari.shop" ,
"status" : "listed" ,
"checked_at" : "2026-11-03T10:05:00.000Z" ,
"results" : [
{
"id" : "meta" ,
"name" : "Meta link safety" ,
"affects" : "Facebook, Messenger, Instagram" ,
"status" : "listed" ,
"detail" : "Meta blocks this domain: The action attempted has been deemed abusive or is otherwise disallowed"
},
{
"id" : "spamhaus_dbl" ,
"name" : "Spamhaus DBL" ,
"affects" : "Email filters (Gmail, Outlook, ISPs), firewalls" ,
"status" : "listed" ,
"detail" : "Listed: abused legit redirector / URL shortener"
},
{
"id" : "tls" ,
"name" : "HTTPS certificate" ,
"affects" : "Every browser and in-app browser" ,
"status" : "ok" ,
"detail" : "Valid for 61 more days (Let’s Encrypt)"
}
],
"manual_checks" : [
{
"platform" : "LinkedIn" ,
"url" : "https://www.linkedin.com/post-inspector/inspect/https%3A%2F%2Fgo.kesari.shop%2F"
},
{
"platform" : "X, WhatsApp, Telegram, TikTok" ,
"url" : null ,
"note" : "No public check exists"
}
],
"history" : [
{
"status" : "listed" ,
"at" : "2026-11-03T10:05:00.000Z"
},
{
"status" : "ok" ,
"at" : "2026-11-02T10:05:00.000Z"
}
]
}
POST /v1/domains/:id /reputation/check
API key domains:write
Once per 10 minutes per domain. Fires domain.blocklisted / domain.reputation_recovered webhooks on change.
Path parameters idstring required
Domain ID
Errors 429 checked-recentlyChecked in the last 10 minutes
curl -X POST "https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/reputation/check" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/reputation/check', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/reputation/check",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"domain" : "go.kesari.shop" ,
"status" : "ok" ,
"checked_at" : "2026-11-03T10:06:00.000Z" ,
"results" : []
}
Team Invite people to your workspace with a role: owner, admin, member or viewer.
GET /v1/team
API key account:read
curl "https://api.cometly.site/v1/team" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/team', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/team",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"members" : [
{
"id" : "usr_5fxw9tcypgsq" ,
"email" : "ananya@kesari.shop" ,
"name" : "Ananya Kapoor" ,
"role" : "owner" ,
"status" : "active" ,
"last_login_at" : "2026-11-03T09:00:00.000Z" ,
"mfa_enabled" : true
}
],
"invites" : [
{
"id" : "a1b2c3d4e5f6a7b8" ,
"email" : "ravi@kesari.shop" ,
"role" : "member" ,
"created_at" : "2026-11-03T10:00:00.000Z" ,
"expires_at" : "2026-11-10T10:00:00.000Z"
}
]
}
POST /v1/team/invites
API key team:write
They get an email link valid for 7 days. Only the owner can invite admins. Seats: Free 2, Pro 10, Business 100.
Body Errors 409 already-memberAlready in the workspace 402 plan-limitNo seats left
curl -X POST "https://api.cometly.site/v1/team/invites" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"email": "ravi@kesari.shop",
"role": "member"
}'const res = await fetch('https://api.cometly.site/v1/team/invites', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"email": "ravi@kesari.shop",
"role": "member"
}),
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/team/invites",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"email": "ravi@kesari.shop",
"role": "member",
},
)
print(res.json())201 application/json Copy
{
"email" : "ravi@kesari.shop" ,
"role" : "member" ,
"expires_in_days" : 7
}
DELETE /v1/team/invites/:id
API key team:write
Path parameters idstring required
Invite ID
curl -X DELETE "https://api.cometly.site/v1/team/invites/a1b2c3d4e5f6a7b8" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/team/invites/a1b2c3d4e5f6a7b8', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.delete(
"https://api.cometly.site/v1/team/invites/a1b2c3d4e5f6a7b8",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"cancelled" : true
}
PATCH /v1/team/members/:id
API key team:write
Path parameters Body rolestring required
admin, member or viewer
curl -X PATCH "https://api.cometly.site/v1/team/members/usr_5fxw9tcypgsq" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"role": "viewer"
}'const res = await fetch('https://api.cometly.site/v1/team/members/usr_5fxw9tcypgsq', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"role": "viewer"
}),
});
const data = await res.json();import os, requests
res = requests.patch(
"https://api.cometly.site/v1/team/members/usr_5fxw9tcypgsq",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"role": "viewer",
},
)
print(res.json())200 application/json Copy
{
"user_id" : "usr_5fxw9tcypgsq" ,
"role" : "viewer"
}
DELETE /v1/team/members/:id
API key team:write
Removing yourself only needs account:read.
Path parameters
curl -X DELETE "https://api.cometly.site/v1/team/members/usr_5fxw9tcypgsq" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/team/members/usr_5fxw9tcypgsq', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.delete(
"https://api.cometly.site/v1/team/members/usr_5fxw9tcypgsq",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"removed" : true
}
API keys & jobs Create scoped keys (optionally limited to some domains) and poll long-running jobs.
GET /v1/api-keys
API key keys:write
curl "https://api.cometly.site/v1/api-keys" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/api-keys', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/api-keys",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"data" : [
{
"id" : "key_ywd3cyggdwe3" ,
"name" : "Zapier" ,
"prefix" : "cmt_live_q1a7Tv" ,
"scopes" : [
"links:read" ,
"links:write"
],
"allowed_domain_ids" : null ,
"last_used_at" : "2026-11-03T10:00:00.000Z" ,
"expires_at" : null ,
"created_at" : "2026-10-01T10:00:00.000Z" ,
"created_by" : "ananya@kesari.shop"
}
]
}
POST /v1/api-keys
API key keys:write
The secret is returned once. A key can’t be given scopes or domains its creator doesn’t have.
Body Errors 403 scope-escalationMore scopes than you have
curl -X POST "https://api.cometly.site/v1/api-keys" \
-H "Authorization: Bearer $COMETLY_API_KEY " \
-H "Content-Type: application/json" \
-d '{
"name": "Zapier",
"scopes": [
"links:read",
"links:write"
],
"expires_in_days": 365
}'const res = await fetch('https://api.cometly.site/v1/api-keys', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "Zapier",
"scopes": [
"links:read",
"links:write"
],
"expires_in_days": 365
}),
});
const data = await res.json();import os, requests
res = requests.post(
"https://api.cometly.site/v1/api-keys",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
json={
"name": "Zapier",
"scopes": ["links:read", "links:write"],
"expires_in_days": 365,
},
)
print(res.json())201 application/json Copy
{
"id" : "key_ywd3cyggdwe3" ,
"name" : "Zapier" ,
"prefix" : "cmt_live_q1a7Tv" ,
"scopes" : [
"links:read" ,
"links:write"
],
"secret" : "cmt_live_q1a7Tv0ZBQURv2Z7LWr3oxl9GDkX6t3sgHgIK8Yz" ,
"note" : "Copy this key now — it won’t be shown again."
}
DELETE /v1/api-keys/:id
API key keys:write
Path parameters idstring required
API key ID
curl -X DELETE "https://api.cometly.site/v1/api-keys/key_ywd3cyggdwe3" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/api-keys/key_ywd3cyggdwe3', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.delete(
"https://api.cometly.site/v1/api-keys/key_ywd3cyggdwe3",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"revoked" : true
}
GET /v1/jobs/:id
API key account:read
Path parameters
curl "https://api.cometly.site/v1/jobs/job_q8m2x7" \
-H "Authorization: Bearer $COMETLY_API_KEY "const res = await fetch('https://api.cometly.site/v1/jobs/job_q8m2x7', {
headers: {
Authorization: `Bearer ${process.env.COMETLY_API_KEY} `,
},
});
const data = await res.json();import os, requests
res = requests.get(
"https://api.cometly.site/v1/jobs/job_q8m2x7",
headers={"Authorization": f"Bearer {os.environ['COMETLY_API_KEY']} "},
)
print(res.json())200 application/json Copy
{
"id" : "job_q8m2x7" ,
"type" : "domain_deletion" ,
"status" : "completed" ,
"progress" : 128 ,
"total" : 128 ,
"result" : {
"links_disabled" : 128
},
"created_at" : "2026-11-03T10:00:00.000Z" ,
"finished_at" : "2026-11-03T10:00:04.000Z"
}
Dashboard sign-in Cookie sessions used by the dashboard (app.cometly.site). Writes need the X-CSRF-Token from /auth/me. Integrations should use API keys instead.
curl "https://api.cometly.site/auth/config"const res = await fetch('https://api.cometly.site/auth/config');
const data = await res.json();import requests
res = requests.get(
"https://api.cometly.site/auth/config",
)
print(res.json())200 application/json Copy
{
"signup_mode" : "invite" ,
"password_min_length" : 10
}
POST /auth/signup
No auth
Same answer whether or not the email exists. Sends a verification email.
Body Errors 403 signup-invite-onlySign-up is invite-only
curl -X POST "https://api.cometly.site/auth/signup" \
-H "Content-Type: application/json" \
-d '{
"email": "asha@example.com",
"password": "monsoon chai on the terrace",
"name": "Asha",
"workspace_name": "Asha Foods"
}'const res = await fetch('https://api.cometly.site/auth/signup', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
"email": "asha@example.com",
"password": "monsoon chai on the terrace",
"name": "Asha",
"workspace_name": "Asha Foods"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.cometly.site/auth/signup",
json={
"email": "asha@example.com",
"password": "monsoon chai on the terrace",
"name": "Asha",
"workspace_name": "Asha Foods",
},
)
print(res.json())202 application/json Copy
{
"status" : "check-your-email"
}
POST /auth/verify-email
No auth
Body tokenstring required
From the email link
curl -X POST "https://api.cometly.site/auth/verify-email" \
-H "Content-Type: application/json" \
-d '{
"token": "TOKEN_FROM_EMAIL"
}'const res = await fetch('https://api.cometly.site/auth/verify-email', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
"token": "TOKEN_FROM_EMAIL"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.cometly.site/auth/verify-email",
json={
"token": "TOKEN_FROM_EMAIL",
},
)
print(res.json())200 application/json Copy
{
"status" : "verified"
}
POST /auth/verify-email/resend
No auth
Body
curl -X POST "https://api.cometly.site/auth/verify-email/resend" \
-H "Content-Type: application/json" \
-d '{
"email": "asha@example.com"
}'const res = await fetch('https://api.cometly.site/auth/verify-email/resend', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
"email": "asha@example.com"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.cometly.site/auth/verify-email/resend",
json={
"email": "asha@example.com",
},
)
print(res.json())202 application/json Copy
{
"status" : "check-your-email"
}
POST /auth/login
No auth
Sets the __Host-cmt_session cookie. If 2FA is on, returns {mfa_required: true, mfa_token} instead — finish with /auth/login/mfa. 5 wrong passwords pause the account for 1–60 minutes.
Body emailstring required
passwordstring required
Errors 401 invalid-credentialsWrong email or password 429 too-many-attemptsTemporarily locked 403 email-not-verifiedConfirm your email first
curl -X POST "https://api.cometly.site/auth/login" \
-c cookies.txt \
-H "Content-Type: application/json" \
-d '{
"email": "ananya@kesari.shop",
"password": "••••••••••"
}'const res = await fetch('https://api.cometly.site/auth/login', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
"email": "ananya@kesari.shop",
"password": "••••••••••"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.cometly.site/auth/login",
json={
"email": "ananya@kesari.shop",
"password": "••••••••••",
},
)
print(res.json())200 application/json Copy
{
"mfa_required" : true ,
"mfa_token" : "pY3…"
}
POST /auth/login/mfa
No auth
Body
curl -X POST "https://api.cometly.site/auth/login/mfa" \
-c cookies.txt \
-H "Content-Type: application/json" \
-d '{
"mfa_token": "pY3…",
"code": "482913"
}'const res = await fetch('https://api.cometly.site/auth/login/mfa', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
"mfa_token": "pY3…",
"code": "482913"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.cometly.site/auth/login/mfa",
json={
"mfa_token": "pY3…",
"code": "482913",
},
)
print(res.json())200 application/json Copy
{
"user" : {
"id" : "usr_5fxw9tcypgsq" ,
"email" : "ananya@kesari.shop" ,
"platform_role" : "user" ,
"mfa_enabled" : true
},
"workspaces" : [
{
"id" : "ws_tg5pvg2u7mwj" ,
"name" : "Kesari Foods" ,
"role" : "owner"
}
],
"csrf_token" : "Xq1…"
}
POST /auth/logout
Dashboard session
curl -X POST "https://api.cometly.site/auth/logout" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/auth/logout', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
console.log(res.status); // 204import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/auth/logout",
headers={"X-CSRF-Token": csrf_token},
)
print(res.status_code)204 No content Copy
(empty body)
POST /auth/logout-all
Dashboard session
curl -X POST "https://api.cometly.site/auth/logout-all" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/auth/logout-all', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/auth/logout-all",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
{
"signed_out_sessions" : 3
}
GET /auth/me
Dashboard session
curl "https://api.cometly.site/auth/me" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/auth/me', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/auth/me",
)
print(res.json())200 application/json Copy
{
"user" : {
"id" : "usr_5fxw9tcypgsq" ,
"email" : "ananya@kesari.shop" ,
"name" : "Ananya Kapoor" ,
"platform_role" : "user" ,
"mfa_enabled" : true ,
"email_verified" : true
},
"workspaces" : [
{
"id" : "ws_tg5pvg2u7mwj" ,
"name" : "Kesari Foods" ,
"status" : "active" ,
"plan_id" : "pro" ,
"role" : "owner"
}
],
"session" : {
"id" : "ses_nx5tk9z6n7cm" ,
"expires_at" : "2026-12-03T10:00:00.000Z" ,
"read_only" : false ,
"impersonated_by" : null
},
"csrf_token" : "Xq1…" ,
"mfa_setup_required" : false
}
POST /auth/password/forgot
No auth
Body
curl -X POST "https://api.cometly.site/auth/password/forgot" \
-H "Content-Type: application/json" \
-d '{
"email": "ananya@kesari.shop"
}'const res = await fetch('https://api.cometly.site/auth/password/forgot', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
"email": "ananya@kesari.shop"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.cometly.site/auth/password/forgot",
json={
"email": "ananya@kesari.shop",
},
)
print(res.json())202 application/json Copy
{
"status" : "check-your-email"
}
POST /auth/password/reset
No auth
Signs out every session.
Body tokenstring required
Valid 30 min, single use
passwordstring required
curl -X POST "https://api.cometly.site/auth/password/reset" \
-H "Content-Type: application/json" \
-d '{
"token": "TOKEN_FROM_EMAIL",
"password": "a brand new passphrase"
}'const res = await fetch('https://api.cometly.site/auth/password/reset', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
"token": "TOKEN_FROM_EMAIL",
"password": "a brand new passphrase"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.cometly.site/auth/password/reset",
json={
"token": "TOKEN_FROM_EMAIL",
"password": "a brand new passphrase",
},
)
print(res.json())200 application/json Copy
{
"status" : "password-updated"
}
POST /auth/password/change
Dashboard session
Body
curl -X POST "https://api.cometly.site/auth/password/change" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"current_password": "••••",
"new_password": "a brand new passphrase"
}'const res = await fetch('https://api.cometly.site/auth/password/change', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"current_password": "••••",
"new_password": "a brand new passphrase"
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/auth/password/change",
headers={"X-CSRF-Token": csrf_token},
json={
"current_password": "••••",
"new_password": "a brand new passphrase",
},
)
print(res.json())200 application/json Copy
{
"status" : "password-updated" ,
"other_sessions_signed_out" : 2
}
POST /auth/mfa/setup
Dashboard session
curl -X POST "https://api.cometly.site/auth/mfa/setup" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/auth/mfa/setup', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/auth/mfa/setup",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
{
"secret" : "JBSWY3DPEHPK3PXP…" ,
"otpauth_url" : "otpauth://totp/Cometly:ananya%40kesari.shop?secret=…&issuer=Cometly"
}
POST /auth/mfa/enable
Dashboard session
Body codestring required
6 digits
curl -X POST "https://api.cometly.site/auth/mfa/enable" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"code": "482913"
}'const res = await fetch('https://api.cometly.site/auth/mfa/enable', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"code": "482913"
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/auth/mfa/enable",
headers={"X-CSRF-Token": csrf_token},
json={
"code": "482913",
},
)
print(res.json())200 application/json Copy
{
"enabled" : true ,
"recovery_codes" : [
"k7q2-m9xd-4hfa" ,
"…"
]
}
POST /auth/mfa/disable
Dashboard session
Not allowed for platform staff.
Body passwordstring required
codestring required
curl -X POST "https://api.cometly.site/auth/mfa/disable" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"password": "••••",
"code": "482913"
}'const res = await fetch('https://api.cometly.site/auth/mfa/disable', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"password": "••••",
"code": "482913"
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/auth/mfa/disable",
headers={"X-CSRF-Token": csrf_token},
json={
"password": "••••",
"code": "482913",
},
)
print(res.json())200 application/json Copy
{
"enabled" : false
}
POST /auth/mfa/recovery-codes
Dashboard session
Body codestring required
Current TOTP code
curl -X POST "https://api.cometly.site/auth/mfa/recovery-codes" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"code": "482913"
}'const res = await fetch('https://api.cometly.site/auth/mfa/recovery-codes', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"code": "482913"
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/auth/mfa/recovery-codes",
headers={"X-CSRF-Token": csrf_token},
json={
"code": "482913",
},
)
print(res.json())200 application/json Copy
{
"recovery_codes" : [
"p3vn-8tqe-2wrk" ,
"…"
]
}
GET /auth/invite
No auth
Query parameters tokenstring required
From the invite email
curl "https://api.cometly.site/auth/invite?token=INVITE_TOKEN"const res = await fetch('https://api.cometly.site/auth/invite?token=INVITE_TOKEN');
const data = await res.json();import requests
res = requests.get(
"https://api.cometly.site/auth/invite",
params={
"token": "INVITE_TOKEN",
},
)
print(res.json())200 application/json Copy
{
"email" : "ravi@kesari.shop" ,
"workspace" : "Kesari Foods" ,
"role" : "member" ,
"invited_by" : "Ananya Kapoor" ,
"needs_password" : true ,
"name" : ""
}
POST /auth/invite/accept
No auth
Body
curl -X POST "https://api.cometly.site/auth/invite/accept" \
-c cookies.txt \
-H "Content-Type: application/json" \
-d '{
"token": "INVITE_TOKEN",
"name": "Ravi",
"password": "teammate passphrase 9"
}'const res = await fetch('https://api.cometly.site/auth/invite/accept', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
"token": "INVITE_TOKEN",
"name": "Ravi",
"password": "teammate passphrase 9"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.cometly.site/auth/invite/accept",
json={
"token": "INVITE_TOKEN",
"name": "Ravi",
"password": "teammate passphrase 9",
},
)
print(res.json())200 application/json Copy
{
"user" : {
"id" : "usr_r4v1…" ,
"email" : "ravi@kesari.shop"
},
"workspaces" : [
{
"name" : "Kesari Foods" ,
"role" : "member"
}
],
"csrf_token" : "…"
}
GET /auth/sessions
Dashboard session
curl "https://api.cometly.site/auth/sessions" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/auth/sessions', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/auth/sessions",
)
print(res.json())200 application/json Copy
{
"data" : [
{
"id" : "ses_nx5tk9z6n7cm" ,
"ip" : "103.21.58.4" ,
"user_agent" : "Mozilla/5.0 (Macintosh…)" ,
"created_at" : "2026-11-01T09:00:00.000Z" ,
"last_seen_at" : "2026-11-03T10:00:00.000Z" ,
"expires_at" : "2026-12-01T09:00:00.000Z" ,
"impersonation" : false ,
"current" : true
}
]
}
DELETE /auth/sessions/:id
Dashboard session
Path parameters idstring required
Session ID
curl -X DELETE "https://api.cometly.site/auth/sessions/ses_nx5tk9z6n7cm" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/auth/sessions/ses_nx5tk9z6n7cm', {
method: 'DELETE',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.delete(
"https://api.cometly.site/auth/sessions/ses_nx5tk9z6n7cm",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
{
"revoked" : true
}
POST /auth/impersonation/stop
Dashboard session
curl -X POST "https://api.cometly.site/auth/impersonation/stop" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/auth/impersonation/stop', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/auth/impersonation/stop",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
{
"status" : "stopped"
}
Master panel (platform staff) Platform-owner endpoints. Require a staff account with 2FA proven in this session; others get 404.
GET /admin/overview
Staff session + 2FA
curl "https://api.cometly.site/admin/overview" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/overview', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/overview",
)
print(res.json())200 application/json Copy
{
"users" : {
"active" : 812 ,
"invited" : 14 ,
"suspended" : 3 ,
"staff" : 3 ,
"with_mfa" : 402 ,
"new_30d" : 61
},
"workspaces" : {
"total" : 790 ,
"suspended" : 2 ,
"free" : 512 ,
"pro" : 241 ,
"business" : 37
},
"clicks_24h" : {
"valid" : 1204331 ,
"filtered" : 88102
},
"security_24h" : {
"failed_logins" : 41 ,
"lockouts" : 2 ,
"auto_bans" : 3 ,
"csrf_rejected" : 1 ,
"critical" : 0
},
"traffic" : {
"minutes" : [
"…"
],
"series" : {
"req_api" : [],
"req_gw" : [],
"rate_limited" : [],
"blocked" : []
}
}
}
GET /admin/users
Staff session + 2FA
Query parameters
curl "https://api.cometly.site/admin/users" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/users', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/users",
)
print(res.json())200 application/json Copy
(empty body)
POST /admin/users/invite
Staff session + 2FA
Body emailstring required
namestring
workspace_namestring
Creates their workspace with them as owner
plan_idstring
free|pro|business
platform_rolestring
user (default), support, admin — staff need an admin
curl -X POST "https://api.cometly.site/admin/users/invite" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "founder@brand.in",
"name": "Priya",
"workspace_name": "Brand",
"plan_id": "pro"
}'const res = await fetch('https://api.cometly.site/admin/users/invite', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"email": "founder@brand.in",
"name": "Priya",
"workspace_name": "Brand",
"plan_id": "pro"
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/users/invite",
headers={"X-CSRF-Token": csrf_token},
json={
"email": "founder@brand.in",
"name": "Priya",
"workspace_name": "Brand",
"plan_id": "pro",
},
)
print(res.json())201 application/json Copy
{
"user_id" : "usr_…" ,
"invite_url" : "https://app.cometly.site/accept-invite?token=…" ,
"expires_in_days" : 7 ,
"workspace_id" : "ws_…"
}
GET /admin/users/:id
Staff session + 2FA
Path parameters
curl "https://api.cometly.site/admin/users/usr_5fxw9tcypgsq" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/users/usr_5fxw9tcypgsq', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/users/usr_5fxw9tcypgsq",
)
print(res.json())200 application/json Copy
(empty body)
PATCH /admin/users/:id
Staff session + 2FA
Path parameters Body
curl -X PATCH "https://api.cometly.site/admin/users/usr_5fxw9tcypgsq" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "suspended",
"reason": "chargeback"
}'const res = await fetch('https://api.cometly.site/admin/users/usr_5fxw9tcypgsq', {
method: 'PATCH',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"status": "suspended",
"reason": "chargeback"
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.patch(
"https://api.cometly.site/admin/users/usr_5fxw9tcypgsq",
headers={"X-CSRF-Token": csrf_token},
json={
"status": "suspended",
"reason": "chargeback",
},
)
print(res.json())200 application/json Copy
(empty body)
POST /admin/users/:id /revoke-sessions
Staff session + 2FA
Path parameters
curl -X POST "https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/revoke-sessions" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/revoke-sessions', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/revoke-sessions",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
{
"revoked" : 2
}
POST /admin/users/:id /reset-mfa
Staff session + 2FA
Path parameters
curl -X POST "https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/reset-mfa" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/reset-mfa', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/reset-mfa",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
{
"mfa_enabled" : false
}
POST /admin/users/:id /password-reset
Staff session + 2FA
Path parameters
curl -X POST "https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/password-reset" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/password-reset', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/password-reset",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
{
"sent" : "password_reset"
}
POST /admin/users/:id /unlock
Staff session + 2FA
Path parameters
curl -X POST "https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/unlock" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/unlock', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/unlock",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
{
"unlocked" : true
}
POST /admin/users/:id /impersonate
Staff session + 2FA
Path parameters Body
curl -X POST "https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/impersonate" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"reason": "Ticket #4411"
}'const res = await fetch('https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/impersonate', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"reason": "Ticket #4411"
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/impersonate",
headers={"X-CSRF-Token": csrf_token},
json={
"reason": "Ticket #4411",
},
)
print(res.json())200 application/json Copy
{
"session_id" : "ses_…" ,
"expires_at" : "…" ,
"read_only" : true
}
DELETE /admin/users/:id
Platform admin + 2FA
Path parameters
curl -X DELETE "https://api.cometly.site/admin/users/usr_5fxw9tcypgsq" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/users/usr_5fxw9tcypgsq', {
method: 'DELETE',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.delete(
"https://api.cometly.site/admin/users/usr_5fxw9tcypgsq",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
{
"deleted" : true ,
"purge_after_days" : 14 ,
"suspended_workspaces" : [
"ws_…"
]
}
POST /admin/users/:id /restore
Platform admin + 2FA
Path parameters
curl -X POST "https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/restore" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/restore', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/users/usr_5fxw9tcypgsq/restore",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
(empty body)
GET /admin/workspaces
Staff session + 2FA
Query parameters qstring
statusstring
plan_idstring
curl "https://api.cometly.site/admin/workspaces" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/workspaces', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/workspaces",
)
print(res.json())200 application/json Copy
(empty body)
PATCH /admin/workspaces/:id
Platform admin + 2FA
Path parameters idstring required
Workspace ID
Body plan_idstring
statusstring
active|suspended
namestring
reasonstring
curl -X PATCH "https://api.cometly.site/admin/workspaces/ws_tg5pvg2u7mwj" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"plan_id": "business"
}'const res = await fetch('https://api.cometly.site/admin/workspaces/ws_tg5pvg2u7mwj', {
method: 'PATCH',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"plan_id": "business"
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.patch(
"https://api.cometly.site/admin/workspaces/ws_tg5pvg2u7mwj",
headers={"X-CSRF-Token": csrf_token},
json={
"plan_id": "business",
},
)
print(res.json())200 application/json Copy
(empty body)
POST /admin/workspaces/:id /credits
Platform admin + 2FA
Path parameters idstring required
Workspace ID
Body deltainteger required
Positive or negative
reasonstring required
curl -X POST "https://api.cometly.site/admin/workspaces/ws_tg5pvg2u7mwj/credits" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"delta": 500,
"reason": "Diwali promo"
}'const res = await fetch('https://api.cometly.site/admin/workspaces/ws_tg5pvg2u7mwj/credits', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"delta": 500,
"reason": "Diwali promo"
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/workspaces/ws_tg5pvg2u7mwj/credits",
headers={"X-CSRF-Token": csrf_token},
json={
"delta": 500,
"reason": "Diwali promo",
},
)
print(res.json())200 application/json Copy
{
"balance" : 5320 ,
"ledger" : []
}
GET /admin/plans
Staff session + 2FA
curl "https://api.cometly.site/admin/plans" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/plans', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/plans",
)
print(res.json())200 application/json Copy
(empty body)
PATCH /admin/plans/:id
Platform admin + 2FA
Path parameters Body
curl -X PATCH "https://api.cometly.site/admin/plans/pro" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"max_api_rpm": 900
}'const res = await fetch('https://api.cometly.site/admin/plans/pro', {
method: 'PATCH',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"max_api_rpm": 900
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.patch(
"https://api.cometly.site/admin/plans/pro",
headers={"X-CSRF-Token": csrf_token},
json={
"max_api_rpm": 900,
},
)
print(res.json())200 application/json Copy
(empty body)
GET /admin/audit
Staff session + 2FA
Query parameters actorstring
e.g. user:usr_…
workspace_idstring
actionstring
Prefix, e.g. admin.user
beforeinteger
Cursor
curl "https://api.cometly.site/admin/audit" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/audit', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/audit",
)
print(res.json())200 application/json Copy
(empty body)
GET /admin/security
Staff session + 2FA
curl "https://api.cometly.site/admin/security" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/security', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/security",
)
print(res.json())200 application/json Copy
(empty body)
GET /admin/security/events
Staff session + 2FA
Query parameters typestring
severitystring
info|warning|critical
ipstring
IP or CIDR
user_idstring
beforeinteger
curl "https://api.cometly.site/admin/security/events" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/security/events', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/security/events",
)
print(res.json())200 application/json Copy
(empty body)
GET /admin/security/blocked-ips
Staff session + 2FA
curl "https://api.cometly.site/admin/security/blocked-ips" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/security/blocked-ips', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/security/blocked-ips",
)
print(res.json())200 application/json Copy
(empty body)
POST /admin/security/blocked-ips
Platform admin + 2FA
Body
curl -X POST "https://api.cometly.site/admin/security/blocked-ips" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"cidr": "203.0.113.0/24",
"reason": "Scraping",
"expires_in_minutes": 1440
}'const res = await fetch('https://api.cometly.site/admin/security/blocked-ips', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"cidr": "203.0.113.0/24",
"reason": "Scraping",
"expires_in_minutes": 1440
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/security/blocked-ips",
headers={"X-CSRF-Token": csrf_token},
json={
"cidr": "203.0.113.0/24",
"reason": "Scraping",
"expires_in_minutes": 1440,
},
)
print(res.json())201 application/json Copy
(empty body)
DELETE /admin/security/blocked-ips/:id
Platform admin + 2FA
Path parameters
curl -X DELETE "https://api.cometly.site/admin/security/blocked-ips/42" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/security/blocked-ips/42', {
method: 'DELETE',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.delete(
"https://api.cometly.site/admin/security/blocked-ips/42",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
(empty body)
GET /admin/abuse
Staff session + 2FA
Query parameters
curl "https://api.cometly.site/admin/abuse" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/abuse', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/abuse",
)
print(res.json())200 application/json Copy
(empty body)
POST /admin/abuse/links/:id /block
Staff session + 2FA
Path parameters Body notestring
Shown to the workspace
curl -X POST "https://api.cometly.site/admin/abuse/links/lnk_594ufv74rqre/block" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/abuse/links/lnk_594ufv74rqre/block', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/abuse/links/lnk_594ufv74rqre/block",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
(empty body)
POST /admin/abuse/links/:id /clear
Platform admin + 2FA
Path parameters Body
curl -X POST "https://api.cometly.site/admin/abuse/links/lnk_594ufv74rqre/clear" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/abuse/links/lnk_594ufv74rqre/clear', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/abuse/links/lnk_594ufv74rqre/clear",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
(empty body)
POST /admin/abuse/reports/:id /resolve
Staff session + 2FA
Path parameters idstring required
Report ID
Body
curl -X POST "https://api.cometly.site/admin/abuse/reports/118/resolve" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/abuse/reports/118/resolve', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/abuse/reports/118/resolve",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
(empty body)
POST /admin/abuse/threats
Platform admin + 2FA
Body valuestring required
Host or URL
kindstring
phishing|malware|spam
curl -X POST "https://api.cometly.site/admin/abuse/threats" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"value": "fake-sbi-rewards.top",
"kind": "phishing"
}'const res = await fetch('https://api.cometly.site/admin/abuse/threats', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
body: JSON.stringify({
"value": "fake-sbi-rewards.top",
"kind": "phishing"
}),
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/abuse/threats",
headers={"X-CSRF-Token": csrf_token},
json={
"value": "fake-sbi-rewards.top",
"kind": "phishing",
},
)
print(res.json())201 application/json Copy
{
"listed" : "fake-sbi-rewards.top" ,
"scanned" : 48210 ,
"flagged" : 0
}
POST /admin/abuse/rescan
Platform admin + 2FA
curl -X POST "https://api.cometly.site/admin/abuse/rescan" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/abuse/rescan', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/abuse/rescan",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
{
"scanned" : 48210 ,
"flagged" : 1 ,
"deep_checked" : 50
}
GET /admin/reputation
Staff session + 2FA
curl "https://api.cometly.site/admin/reputation" \
-b cookies.txt -c cookies.txtconst res = await fetch('https://api.cometly.site/admin/reputation', {
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.get(
"https://api.cometly.site/admin/reputation",
)
print(res.json())200 application/json Copy
(empty body)
POST /admin/reputation/:id /check
Staff session + 2FA
Path parameters idstring required
Domain ID
curl -X POST "https://api.cometly.site/admin/reputation/dom_kd292xv8n8tg/check" \
-b cookies.txt -c cookies.txt \
-H "X-CSRF-Token: $CSRF_TOKEN"const res = await fetch('https://api.cometly.site/admin/reputation/dom_kd292xv8n8tg/check', {
method: 'POST',
headers: {
'X-CSRF-Token': csrfToken, // from GET /auth/me,
},
credentials: 'include',
});
const data = await res.json();import requests
session = requests.Session() # signed in via /auth/login
res = session.post(
"https://api.cometly.site/admin/reputation/dom_kd292xv8n8tg/check",
headers={"X-CSRF-Token": csrf_token},
)
print(res.json())200 application/json Copy
(empty body)
Public & short-domain endpoints Served on api.cometly.site without a key, or on every short domain.
curl "https://api.cometly.site/health"const res = await fetch('https://api.cometly.site/health');
const data = await res.json();import requests
res = requests.get(
"https://api.cometly.site/health",
)
print(res.json())200 application/json Copy
{
"ok" : true ,
"db" : true ,
"redis" : true
}
GET /sdk/attribution.js
No auth
Stores the cmt_id from the URL in a first-party cookie so your checkout can send it to POST /v1/conversions.
curl "https://api.cometly.site/sdk/attribution.js"const res = await fetch('https://api.cometly.site/sdk/attribution.js');
const text = await res.text();import requests
res = requests.get(
"https://api.cometly.site/sdk/attribution.js",
)
print(res.text)200 application/javascript Copy
application/javascript
curl "https://api.cometly.site/openapi.json"const res = await fetch('https://api.cometly.site/openapi.json');
const data = await res.json();import requests
res = requests.get(
"https://api.cometly.site/openapi.json",
)
print(res.json())200 application/json Copy
(empty body)
curl "https://api.cometly.site/docs"const res = await fetch('https://api.cometly.site/docs');
const text = await res.text();import requests
res = requests.get(
"https://api.cometly.site/docs",
)
print(res.text)200 text/html Copy
text/html
GET /:slug short domain
No auth
On any short domain. Redirects (302), or serves a password, deep-link, UPI or preview page. ?qr=1 marks a QR scan and is removed before redirecting; other query parameters are passed to the destination.
Path parameters slugstring required
Case-insensitive
curl -i "https://go.kesari.shop/diwali"const res = await fetch('https://go.kesari.shop/diwali', {
redirect: 'manual',
});
console.log(res.status, res.headers.get('location'));import requests
res = requests.get(
"https://go.kesari.shop/diwali",
allow_redirects=False,
)
print(res.status_code, res.headers["Location"])302 text/html Copy
302 → Location: https://kesari.shop/diwali (or an HTML page)
POST /:slug short domain
No auth
Path parameters Form fields passwordstring required
Form field
curl -X POST -i "https://go.kesari.shop/diwali" \
--data-urlencode "password=chai2026"const res = await fetch('https://go.kesari.shop/diwali', {
method: 'POST',
redirect: 'manual',
body: new URLSearchParams({"password":"chai2026"}),
});
console.log(res.status, res.headers.get('location'));import requests
res = requests.post(
"https://go.kesari.shop/diwali",
data={
"password": "chai2026",
},
allow_redirects=False,
)
print(res.status_code, res.headers["Location"])302 text/html Copy
302 → Location: https://kesari.shop/diwali (or an HTML page)
GET /short domain
No auth
Redirects to the domain’s homepage_url if set.
curl -i "https://go.kesari.shop/"const res = await fetch('https://go.kesari.shop/', {
redirect: 'manual',
});
console.log(res.status, res.headers.get('location'));import requests
res = requests.get(
"https://go.kesari.shop/",
allow_redirects=False,
)
print(res.status_code, res.headers["Location"])302 text/html Copy
302 → Location: https://kesari.shop/diwali (or an HTML page)
GET /reportshort domain
No auth
curl "https://go.kesari.shop/report"const res = await fetch('https://go.kesari.shop/report');
const text = await res.text();import requests
res = requests.get(
"https://go.kesari.shop/report",
)
print(res.text)200 text/html Copy
text/html
POST /reportshort domain
No auth
Form-encoded. 5 per IP per hour. Three reporters in 7 days put the link in the review queue.
Form fields urlstring
The short link (or send slug)
slugstring
Instead of url
categorystring
phishing, scam, malware, spam, other
reasonstring required
5–2000 chars
emailstring
Optional, for follow-up
curl -X POST "https://go.kesari.shop/report" \
--data-urlencode "url=https://go.kesari.shop/diwali" \
--data-urlencode "category=phishing" \
--data-urlencode "reason=Asks for my bank password"const res = await fetch('https://go.kesari.shop/report', {
method: 'POST',
body: new URLSearchParams({"url":"https://go.kesari.shop/diwali","category":"phishing","reason":"Asks for my bank password"}),
});
const text = await res.text();import requests
res = requests.post(
"https://go.kesari.shop/report",
data={
"url": "https://go.kesari.shop/diwali",
"category": "phishing",
"reason": "Asks for my bank password",
},
)
print(res.text)200 text/html Copy
text/html
GET /.well-known/cometly-healthshort domain
No auth
curl "https://go.kesari.shop/.well-known/cometly-health"const res = await fetch('https://go.kesari.shop/.well-known/cometly-health');
const data = await res.json();import requests
res = requests.get(
"https://go.kesari.shop/.well-known/cometly-health",
)
print(res.json())200 application/json Copy
{
"ok" : true ,
"host" : "go.kesari.shop"
}
GET /robots.txtshort domain
No auth
curl "https://go.kesari.shop/robots.txt"const res = await fetch('https://go.kesari.shop/robots.txt');
const text = await res.text();import requests
res = requests.get(
"https://go.kesari.shop/robots.txt",
)
print(res.text)200 text/plain Copy
text/plain
GET /favicon.icoshort domain
No auth
curl "https://go.kesari.shop/favicon.ico"const res = await fetch('https://go.kesari.shop/favicon.ico');
console.log(res.status); // 204import requests
res = requests.get(
"https://go.kesari.shop/favicon.ico",
)
print(res.status_code)204 No content Copy
(empty body)
No endpoints match your search.
Generated from the same catalogue as openapi.json ; a test fails the build if any route is missing from it.