API documentation page

Cached repository-owned Markdown plus endpoint metadata; restart/watch to refresh.

Responses

• 200 HTML documentation.

API documentation (JSON)

Returns this endpoint catalog. Shared API failures use { error, code, requestId } with an X-Request-ID header.

Responses

• 200 Array of endpoint groups.

Liveness

Process is responding; does not probe optional providers.

Responses

• 200 { status: "ok" }

Readiness

Traffic is accepted only after database/index readiness. Readiness becomes false on draining or loss of DB connection.

Responses

• 200 { status: "ready" }
• 503 { status: "not_ready" }

Search public commit messages

Public GitHub commit-message phrase search. The trimmed input is quoted; quotes, backslashes and control characters are rejected. No owner/repo restriction, credentials or cache.

Parameters

Name	Type	Required	Description
word	string	yes	Message phrase, 1-200 characters.
page (query)	number	no	Page 1-1000; default 1. Search is also subject to GitHub result limits.
per_page (query)	number	no	Page size 1-100; default 30.

Responses

• 200 GitHub search object with total_count, incomplete_results and items; extra upstream fields are retained.
• 400 Invalid input, code, path encoding or pagination.
• 413 Body exceeds 100 KiB or form has over 100 parameters.
• 415 Unsupported request encoding.
• 429 Rate limit exceeded.
• 500 Unexpected internal failure; details are masked.
• 404 GitHub resource not found.
• 502 GitHub network, HTTP or response-contract failure.
• 503 GitHub denied access or rate limited the request.
• 504 GitHub deadline exceeded or request cancelled.

List repository commits

Public commit list for a validated owner/repository. Upstream pagination is explicit; native GitHub array shape is retained.

Parameters

Name	Type	Required	Description
owner	string	yes	Account/organization name, 1-39 characters.
repo	string	yes	Repository name, 1-100 letters, digits, dots, underscores or hyphens.
page (query)	number	no	Page 1-1000; default 1. Search is also subject to GitHub result limits.
per_page (query)	number	no	Page size 1-100; default 30.

Responses

• 200 GitHub commit array for the requested page.
• 400 Invalid input, code, path encoding or pagination.
• 413 Body exceeds 100 KiB or form has over 100 parameters.
• 415 Unsupported request encoding.
• 429 Rate limit exceeded.
• 500 Unexpected internal failure; details are masked.
• 404 GitHub resource not found.
• 502 GitHub network, HTTP or response-contract failure.
• 503 GitHub denied access or rate limited the request.
• 504 GitHub deadline exceeded or request cancelled.

List a page of stored URLs (owner)

Owner bearer authorization required. Ascending immutable _id order, projected fields and an opaque next cursor.

Parameters

Name	Type	Required	Description
limit (query)	number	no	1-100; default 25.
after (query)	string	no	24 lowercase hexadecimal characters; use pagination.next from the previous response.

Responses

• 200 { error: false, message: "URLs found", data: [...], pagination: { limit, next } }. next is null at the end.
• 401 Owner bearer authorization required.
• 400 Invalid input, code, path encoding or pagination.
• 413 Body exceeds 100 KiB or form has over 100 parameters.
• 415 Unsupported request encoding.
• 429 Rate limit exceeded.
• 500 Unexpected internal failure; details are masked.
• 503 Database unavailable or bounded code allocation exhausted.

Create or reuse a short URL (owner)

Owner bearer authorization required. Global exact original-URL reuse without canonicalization. New numeric codes use a cryptographically random 47-bit allocation space, with unique indexes and five bounded attempts.

Parameters

Name	Type	Required	Description
original_url (body)	string	yes	Absolute HTTP(S) URL, at most 2048 characters, no embedded credentials, whitespace or control characters.

Responses

• 200 Projected document { _id, original_url, short_url, creation_date }, created or reused.
• 401 Owner bearer authorization required.
• 400 Invalid input, code, path encoding or pagination.
• 413 Body exceeds 100 KiB or form has over 100 parameters.
• 415 Unsupported request encoding.
• 429 Rate limit exceeded.
• 500 Unexpected internal failure; details are masked.
• 503 Database unavailable or bounded code allocation exhausted.

Get a stored URL (public)

Public lookup by issued numeric short code; no redirect and no list access.

Parameters

Name	Type	Required	Description
short_url	number	yes	Nonnegative safe integer: canonical digits or legacy four-digit zero padding. Existing issued codes remain supported.

Responses

• 200 Projected URL document { _id, original_url, short_url, creation_date }.
• 400 Invalid input, code, path encoding or pagination.
• 413 Body exceeds 100 KiB or form has over 100 parameters.
• 415 Unsupported request encoding.
• 429 Rate limit exceeded.
• 500 Unexpected internal failure; details are masked.
• 404 URL not found.
• 503 Database unavailable or bounded code allocation exhausted.

Delete a short URL (owner)

Owner bearer authorization required. Deletes the stored mapping; a missing mapping returns 404.

Parameters

Name	Type	Required	Description
short_url	number	yes	Nonnegative safe integer: canonical digits or legacy four-digit zero padding. Existing issued codes remain supported.

Responses

• 200 Projected deleted URL document.
• 401 Owner bearer authorization required.
• 400 Invalid input, code, path encoding or pagination.
• 413 Body exceeds 100 KiB or form has over 100 parameters.
• 415 Unsupported request encoding.
• 429 Rate limit exceeded.
• 500 Unexpected internal failure; details are masked.
• 404 URL not found.
• 503 Database unavailable or bounded code allocation exhausted.