Operator UI API

This API provides endpoints to retrieve and manage blocked tokens, user agents, and referrers used within the Operator UI.

Endpoints

Retrieve List of Blocked Tokens

GET /api/v1/operator_ui/modules/blocked_tokens/

Fetches a list of blocked tokens, supporting optional filtering, sorting, and limiting.

Query Parameters:

• search (optional): Filter tokens matching the search term.
• limit (optional): Limit number of results.
• sort (optional): Sort order, "asc" or "desc" (default: "asc").

Responses:

• 200 OK with JSON array of blocked tokens.
• 404 Not Found if no tokens found.
• 500 Internal Server Error on failure.

Retrieve a Specific Blocked Token

GET /api/v1/operator_ui/modules/blocked_tokens/{token}

Fetches details of a specific blocked token.

Path Parameter:

• token: The token string to retrieve.

Responses:

• 200 OK with JSON object of the token.
• 404 Not Found if token does not exist.
• 500 Internal Server Error on failure.

Retrieve List of Blocked User Agents

GET /api/v1/operator_ui/modules/blocked_user_agents/

Fetches a list of blocked user agents, with optional sorting and limiting.

Query Parameters:

• limit (optional): Limit number of results.
• sort (optional): "asc" or "desc" (default: "asc").

Responses:

• 200 OK with JSON array of user agents.
• 404 Not Found if none found.
• 500 Internal Server Error on failure.

Retrieve a Specific Blocked User Agent

GET /api/v1/operator_ui/modules/blocked_user_agents/{user_agent}

Retrieves details of a specific blocked user agent.

Path Parameter:

• user_agent: URL-safe Base64 encoded string (without padding). Decode before use; if decoding fails, the server returns 400 Bad Request.

Responses:

• 200 OK with JSON object of the user agent.
• 404 Not Found if not found.
• 500 Internal Server Error on failure.

Retrieve List of Blocked Referrers

GET /api/v1/operator_ui/modules/blocked_referrers/

Fetches a list of blocked referrers, with optional sorting and limiting.

Query Parameters:

• limit (optional): Limit number of results.
• sort (optional): "asc" or "desc" (default: "asc").

Responses:

• 200 OK with JSON array of referrers.
• 404 Not Found if none found.
• 500 Internal Server Error on failure.

Retrieve a Specific Blocked Referrer

GET /api/v1/operator_ui/modules/blocked_referrers/{referrer}

Retrieves details of a specific blocked referrer.

Path Parameter:

• referrer: URL-safe Base64 encoded string (without padding). Decode before use; if decoding fails, return 400 Bad Request. The response includes the decoded referrer.

Responses:

• 200 OK with JSON object containing the referrer.
• 404 Not Found if not found.
• 500 Internal Server Error on failure.

Additional Notes

• For User Agents and Referrers, the path parameters are URL-safe Base64 encoded (per RFC 4648, using - and _ instead of + and /) with padding (=) removed. Clients should remove padding when constructing requests and restore it before decoding.
• All endpoints returning specific items will respond with 404 Not Found if the item does not exist.
• Errors during processing will return 500 Internal Server Error with an error message.