Topline Docs

API & compatibility

External API Endpoint Reference

Generated method, path, authentication, scope, stability, and purpose for every public harness endpoint.

External API Endpoint Reference

Generated from PUBLIC_HARNESS_ENDPOINTS. Do not edit this file directly. Run npm run docs:generate.

These are the stable, customer-facing authorization, Harness MCP, artifact app, and Developer Access endpoints. Internal application routes are intentionally excluded.

MethodPathAuthenticationScopeStabilityPurpose
GET/api/docspublic-stableList or search the public documentation catalog with docs contract and build metadata.
GET/api/docs/index.jsonpublic-stableRead the public-only documentation content bundle used by static renderers and agents.
GET/api/docs/{id}public-stableRead one public documentation entry as structured JSON.
GET/api/docs/{id}.mdpublic-stableRead one public documentation entry as Markdown.
POST/api/docs/feedbackpublic-stableRecord a text-free helpful, not-helpful, or outdated signal for a current public document and optional heading.
POST/api/docs/selectionpublic-stableRecord a privacy-bounded public document selected from search using only the document id and allowlisted product terms.
GET/docs/openapi.jsonpublic-stableRead the generated OpenAPI 3.1 description of supported public endpoints.
GET/.well-known/oauth-protected-resource/mcp/buildpublic-stableOAuth protected-resource metadata for Topline Build MCP clients.
GET/.well-known/oauth-protected-resource/mcp/workspacepublic-stableOAuth protected-resource metadata for Topline Workspace MCP clients.
GET/.well-known/oauth-protected-resource/mcp/harnesspublic-stableOAuth protected-resource metadata for Harness MCP clients.
GET/.well-known/oauth-protected-resourcepublic-stableCompatibility alias for Harness OAuth protected-resource metadata.
GET/.well-known/oauth-authorization-serverpublic-stableOAuth authorization-server metadata and supported scopes.
GET/.well-known/openid-configurationpublic-stableCompatibility alias for Harness OAuth authorization-server metadata.
POST/oauth/registerpublic-stableRegister a public OAuth client and approved redirect URIs.
GET/oauth/authorizebrowser_session-stableAuthorize an MCP client with PKCE and explicit scopes.
POST/oauth/tokenpublic-stableExchange an authorization code or refresh token for an access token.
POST/oauth/revokepublic-stableRevoke the OAuth access or refresh token supplied in the request body.
GET/mcp/buildpublic-stableReturn the Topline Build MCP identity and artifact tool inventory.
POST/mcp/buildconnector_or_oauth_bearer-stableInvoke the Topline Build MCP streamable HTTP endpoint.
GET/mcp/workspacepublic-stableReturn the Topline Workspace MCP identity and workspace tool inventory.
POST/mcp/workspaceconnector_or_oauth_bearer-stableInvoke the Topline Workspace MCP streamable HTTP endpoint.
GET/mcp/harnesspublic-stableReturn Harness MCP server identity and the unfiltered tool-name inventory.
POST/mcp/harnessconnector_or_oauth_bearer-stableInvoke the streamable HTTP Harness MCP JSON-RPC endpoint.
POST/api/harness/artifact-appsconnector_or_oauth_bearerharness:artifact:writestableCreate or update a private artifact-app draft.
POST/api/harness/artifact-apps/{artifactId}/deploy-bundleconnector_or_oauth_bearerharness:artifact:deploystableUpload and deploy a validated artifact-app tar.gz bundle.
GET/api/harness/artifact-apps/{artifactId}/deploymentsconnector_or_oauth_bearerharness:artifact:readstableList recent draft deployment state and readiness.
GET/api/harness/artifact-apps/{artifactId}/logsconnector_or_oauth_bearerharness:artifact:readstableRead bounded and redacted artifact deployment logs.
GET/api/harness-connectorsbrowser_session-stableRead Developer Access configuration and the current operator's connector tokens.
POST/api/harness-connectors/products/{product}/verificationsbrowser_session-stableCreate a short-lived, product-bound MCP connection verification challenge.
GET/api/harness-connectors/products/{product}/verifications/{verificationId}browser_session-stableRead the owner-scoped result of an MCP connection verification challenge.
POST/api/harness-connectors/oauth-authorizations/{authorizationId}/revokebrowser_session-stableRevoke one active OAuth authorization owned by the current operator.
POST/api/harness-connectors/bedrock-tokenbrowser_session-stableGenerate a one-hour Bedrock key from the customer-account runtime role.
POST/api/harness-connectors/tokensbrowser_session-stableCreate a manual fallback connector token.
POST/api/harness-connectors/tokens/{tokenId}/revokebrowser_session-stableRevoke one connector token owned by the current operator.