API Documentation
Complete reference for the Redirect Manager REST API
Learn how to integrate with Redirect Manager using our RESTful API endpoints.
API Overview
The Redirect Manager API provides RESTful endpoints for managing URL redirects, authentication, and system health monitoring.
All endpoints use JSON for request and response payloads. Authentication is required for most endpoints using JWT tokens.
Base URL
http(s)://${YOUR_DOMAIN:-localhost:8080}/api/v1
Note:
You can configure the API base path prefix using the BASE_API_PATH environment variable. By default, it points to /api.
Why you might want to change the base path:
- To avoid conflicts with other services running on the same domain.
- To avoid conflicts with your redirects paths.
Endpoint Categories
Authentication
Obtain and manage authentication tokens for API access.
/auth/login
- Obtain JWT token
Redirects
Manage URL redirect rules with full CRUD operations.
/redirects
- List all redirects
/redirects
- Create new redirect
/redirects/:id
- Update redirect
/redirects/:id
- Delete redirect
Users
Manage user accounts and permissions. Requires Admin role.
/users
- List all users
/users
- Create new user
API Tokens
Manage programmatic access for your automation and tools.
/api-tokens
- List your tokens
/api-tokens
- Create new token
Health Check
Monitor service health and status.
/health
- Service health status
Quick Start
Get started with the Redirect Manager API in just a few steps.
Authenticate
Obtain a JWT token using your admin credentials
Make API Calls
Include the token in Authorization header for protected endpoints
Manage Redirects
Create, update, and delete URL redirect rules