Skip to content
noBSredir

API reference

This is the full API reference. No SDK - just HTTP. Every endpoint documented with curl examples you can copy-paste. If something’s unclear, it’s a bug in the docs.

Want to import endpoints into Postman or Insomnia? Grab the OpenAPI spec.

Base URL

https://nobsredir.com/api

All responses are bullshit-free JSON unless otherwise noted (CSV exports).

Authentication

Pass your API key in the X-API-Key header:

X-API-Key: nobs_abc123...

API keys are workspace-scoped and created via the dashboard or the API Keys endpoint. The full key is only shown once at creation.

See Authentication for full details.

Error format

Every error returns JSON with an error field and an appropriate HTTP status code:

{"error": "Human readable message"}

Common status codes:

StatusMeaning
400Bad request - missing or invalid fields
401Unauthorized - missing or invalid auth
402Payment required - plan limit reached
403Forbidden - insufficient role
404Not found
409Conflict - duplicate resource
410Gone - expired resource
500Server error

Rate limits

EndpointLimit
Link creation30 requests per 10 seconds per workspace
Bulk link creation5 requests per 10 seconds per workspace
Domain verification1 request per 10 seconds per domain
Monitoring check1 per workspace per hour

Content type

Send Content-Type: application/json for all POST/PATCH/DELETE requests with a body.

Getting started

New here? The Quick start guide has copy-paste examples in curl, JavaScript, and Python.

Quick example

Terminal window
# Create a short link
curl -X POST https://nobsredir.com/api/workspaces/ws_abc123/links \
-H "X-API-Key: nobs_your_key_here" \
-H "Content-Type: application/json" \
-d '{"target": "https://example.com/long-page"}'
{
"id": "lnk_xyz789",
"domain": "fnl.sh",
"slug": "a1b2c3",
"target": "https://example.com/long-page",
"short_url": "https://fnl.sh/a1b2c3"
}