View Markdown

Version 0.1.0

Sourced API reference

Endpoint reference for the Sourced API.

Base URLhttps://sourced.sh

40Operations

36Schemas

5Warnings

Review before launch

Configured method migration.create_stainless_migration_scan points at POST /api/migration/stainless/scans, but that operation is missing from OpenAPI.
Configured method migration.get_stainless_migration_report points at GET /api/migration/stainless/reports/{runId}, but that operation is missing from OpenAPI.
Configured method migration.get_stainless_migration_scan points at GET /api/migration/stainless/scans/{scanId}, but that operation is missing from OpenAPI.
Configured method migration.list_stainless_migration_scans points at GET /api/migration/stainless/scans, but that operation is missing from OpenAPI.
Configured method migration.start_stainless_migration_scan points at POST /api/migration/stainless/start, but that operation is missing from OpenAPI.

Api Keys

3 operations

GET/api/api-keysList workspace API keys POST/api/api-keysCreate a workspace API key DELETE/api/api-keys/{apiKeyId}Revoke an API key

Artifacts

6 operations

GET/api/artifacts/downloadDownload a run artifact DELETE/api/runs/{runId}/artifactsDelete downloadable artifact references for a run GET/api/runs/{runId}/docs-preview/publishList Sourced-managed docs publications for a run POST/api/runs/{runId}/docs-preview/publishPublish generated docs to a Sourced-managed subpath GET/api/runs/{runId}/docs-preview/shareList shared docs-preview links for a run POST/api/runs/{runId}/docs-preview/shareCreate a noindex docs-preview share link

System

2 operations

GET/api/auth/configGet auth configuration GET/api/healthService health probe

Billing

3 operations

GET/api/billing/catalogList billing plans POST/api/billing/checkoutCreate a checkout session POST/api/billing/portalCreate a customer portal session

Identity

1 operation

GET/api/meGet the authenticated workspace snapshot

Members

4 operations

GET/api/membersList workspace members POST/api/membersInvite a workspace member DELETE/api/members/{memberId}Remove a workspace member PATCH/api/members/{memberId}Update a member role or status

Migration

1 operation

GET/api/migration/summaryGet migration workspace summary

Notifications

2 operations

GET/api/notificationsGet workspace notification settings PATCH/api/notificationsUpdate workspace notification settings

Projects

5 operations

GET/api/projectsList projects in the workspace POST/api/projectsCreate a project DELETE/api/projects/{projectId}Archive a project GET/api/projects/{projectId}Get a project PATCH/api/projects/{projectId}Update project settings

Domains

4 operations

GET/api/projects/{projectId}/domainsList docs domains for a project POST/api/projects/{projectId}/domainsAdd or update a docs domain DELETE/api/projects/{projectId}/domains/{domainId}Remove a docs domain PATCH/api/projects/{projectId}/domains/{domainId}Verify, rotate, or update a docs domain

Runs

4 operations

GET/api/projects/{projectId}/runsList runs for a project GET/api/runs/{runId}Get a run by id POST/api/runs/{runId}/cancelCancel a queued, running, or blocked run POST/api/runs/{runId}/retryRetry a run from retained inputs

Reports

1 operation

POST/api/reports/startStart a migration / generation report run

Publishing

4 operations

GET/api/runs/{runId}/publish/dry-runList publishing actions for a run POST/api/runs/{runId}/publish/dry-runRun an SDK/docs publishing dry-run POST/api/runs/{runId}/publish/publishRequest publish approval POST/api/runs/{runId}/publish/rollbackRequest rollback approval

Was this helpful?