Routebase Public API Reference
37 endpoints
API Specs
5 endpointsRead specifications and their versions, export them as OpenAPI, and record which version a deployment put into an environment.
GET/api/projects/{projectId}/specsList the specifications of a projectGET/api/projects/{projectId}/specs/{specId}/versionsList the versions of a specificationGET/api/projects/{projectId}/specs/{specId}/exportExport the current state of a specificationGET/api/projects/{projectId}/specs/{specId}/versions/{versionId}/exportExport a published versionPOST/api/projects/{projectId}/specs/{specId}/versions/{versionId}/promoteRecord that a version went into an environment
CI & Test Runs
7 endpointsRun test suites from a pipeline and collect the result. These endpoints back the
routebase CLI and the Routebase GitHub Action, and they are the ones a CI job
calls directly.
POST/api/cli/runRun a test suite and wait for the resultGET/api/cli/suitesList the test suites of a projectGET/api/cli/environmentsList the environments of a projectGET/api/cli/runs/{id}/statusGet the progress of a test runGET/api/cli/runs/{id}/reportDownload the report of a finished runGET/api/projects/{projectId}/test-suitesList the test suites of a projectPOST/api/projects/{projectId}/test-suites/{suiteId}/executeExecute a test suite
Docs as Code
7 endpointsKeep documentation pages in your own repository and push them into Routebase from
a pipeline. These endpoints back routebase docs push and routebase docs pull.
GET/api/projects/{projectId}/docsList the documentations of a projectGET/api/projects/{projectId}/docs/{docId}/versions/{versionId}/treeGet the page tree of a versionPOST/api/projects/{projectId}/docs/{docId}/versions/{versionId}/pagesCreate a pageGET/api/projects/{projectId}/docs/{docId}/versions/{versionId}/pages/{pageId}Get a page with its contentPUT/api/projects/{projectId}/docs/{docId}/versions/{versionId}/pages/{pageId}Update a pagePOST/api/projects/{projectId}/docs/{docId}/versions/{versionId}/foldersCreate a folderPUT/api/projects/{projectId}/docs/{docId}/versions/{versionId}/tree/reorderReorder the items under one parent
SCIM
14 endpointsSCIM 2.0 user and group provisioning, as consumed by Okta, Microsoft Entra ID and other identity providers. Available on plans that include SSO.
GET/scim/v2/{orgSlug}/ServiceProviderConfigDescribe what this SCIM service supportsGET/scim/v2/{orgSlug}/ResourceTypesList the supported resource typesGET/scim/v2/{orgSlug}/SchemasList the supported schemasGET/scim/v2/{orgSlug}/UsersList usersPOST/scim/v2/{orgSlug}/UsersProvision a userGET/scim/v2/{orgSlug}/Users/{id}Get a userPUT/scim/v2/{orgSlug}/Users/{id}Replace a userPATCH/scim/v2/{orgSlug}/Users/{id}Patch a userDELETE/scim/v2/{orgSlug}/Users/{id}Deprovision a userGET/scim/v2/{orgSlug}/GroupsList groupsPOST/scim/v2/{orgSlug}/GroupsProvision a groupGET/scim/v2/{orgSlug}/Groups/{id}Get a groupPATCH/scim/v2/{orgSlug}/Groups/{id}Patch a groupDELETE/scim/v2/{orgSlug}/Groups/{id}Deprovision a group
Security
4 endpointsStart an OWASP scan, poll it to completion, and read the findings. The SARIF export feeds GitHub code scanning and comparable tools.
POST/api/projects/{projectId}/security/scan-profiles/{profileId}/runStart a security scanGET/api/projects/{projectId}/security/scan-runs/{runId}Get a scan runGET/api/projects/{projectId}/security/findingsList security findingsGET/api/projects/{projectId}/security/findings/export/sarifExport findings as SARIF