Rucho

Lists all available API endpoints provided by this server.

Returns a JSON array of EndpointInfo objects, each describing an endpoint’s
path, HTTP method, and a brief description.

HTTP Method:

  • GET

Responses:

  • 200 OK: Successfully returns the list of endpoints.
  • 500 Internal Server Error: If there’s an issue serializing the endpoint data.
get
https://rucho.org/endpoints

Response

200 application/json

Lists all available API endpoints

Represents information about an API endpoint.

descriptionstringrequired

A brief description of the endpoint’s purpose.

Example:Echoes request details for GET.

methodstringrequired

The HTTP method of the endpoint (e.g., “GET”).

Example:GET

pathstringrequired

The path of the endpoint (e.g., “/get”).

Example:/get

get/endpoints
 
200 application/json

Handles GET requests to `/get`.

Echoes back the request’s method and headers as a JSON object.

HTTP Method:

  • GET

Responses:

  • 200 OK: Returns a JSON object containing the method and headers.
get
https://rucho.org/get

Response

200 application/json

Echoes request details (includes a tls object over HTTPS)

get/get
 
200 application/json

Handles HEAD requests to `/get`.

Responds with the same headers as a GET request to /get, but with no body.
This is typically used to check if a resource exists or to get its metadata
without transferring the entire content.

HTTP Method:

  • HEAD

Responses:

  • 200 OK: Returns an empty body with appropriate headers.
head
https://rucho.org/get

Response

200

Responds with headers for GET query

head/get
 
200

Returns all request headers as a JSON object.

Useful for debugging what headers are being sent by the client,
including auth tokens, proxy headers, and custom headers.

HTTP Method:

  • GET

Responses:

  • 200 OK: Returns a JSON object containing all request headers.
get
https://rucho.org/headers

Response

200 application/json

Returns all request headers

get/headers
 
200 application/json

Returns the client's IP address.

Extracts the client IP from request headers. Checks X-Forwarded-For first
(for proxied requests), then X-Real-IP as a fallback.

HTTP Method:

  • GET

Responses:

  • 200 OK: Returns a JSON object containing the client’s origin IP.
get
https://rucho.org/ip

Response

200 application/json

Returns the client’s IP address

get/ip
 
200 application/json