API Reference

Complete documentation of all HTTP REST API routes supported by GO Shortener.

Public Endpoints

Shorten URL

POST /api/links/shorten

Create a new shortened link. Available to anonymous visitors and authenticated users.

• Request Body:

  {
    "url": "https://example.com/long-page-url",
    "expiration_days": 7,
    "turnstile_token": "optional_token_string"
  }
  

• Response 201 Created:

  {
    "short_code": "K8xP2q",
    "short_url": "https://go.arcn.online/K8xP2q",
    "destination_url": "https://example.com/long-page-url",
    "expires_at": "2026-09-10T14:30:00Z",
    "created_at": "2026-09-03T14:30:00Z"
  }
  

Redirect to Destination

GET /{code}

Resolves short code and redirects visitor:

• 302 Found: Redirects to destination_url via Location header.
• 410 Gone: Displayed if link has expired.
• 403 Forbidden: Displayed if link has been disabled by moderation.
• 404 Not Found: Short code does not exist.

Link Metadata

GET /api/links/{code}/info

Fetches public information for a shortened link.

Submit Abuse Report

POST /api/reports

Flags a malicious link for administrator review.

• Request Body:

  {
    "short_code": "K8xP2q",
    "reason": "phishing",
    "details": "Suspicious login prompt detected.",
    "turnstile_token": "optional_token"
  }
  

• Response 201 Created: {"status": "report_submitted"}

Health Check

GET /api/health

Returns application readiness:

• Response 200 OK: {"status": "ok"}

Authentication Endpoints

User Endpoints (Authenticated)

Admin Endpoints (RBAC Protected)

System & Users

Links & Moderation