/
SC
scalar
/
Core
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 3h ago · Updated 3h ago
OpenAPI 3.1.1
2026-08-20
218
79
312.0 KB
62616e733c3b
access-groups
8
get
/v1/access-groups/{slug}
post
/v1/access-groups
delete
/v1/access-groups/{uid}
patch
/v1/access-groups/{uid}
post
/v1/access-groups/{uid}/emails
delete
/v1/access-groups/{uid}/emails
post
/v1/access-groups/{uid}/domains
delete
/v1/access-groups/{uid}/domains
analytics
4
get
/analytics/projects/{projectUid}/overview
get
/analytics/projects/{projectUid}/pages
get
/analytics/projects/{projectUid}/referrers
get
/analytics/projects/{projectUid}/consumers
api-docs
15
post
/managed-doc/access-group
delete
/managed-doc/access-group
post
/managed-doc/available
get
/managed-doc/{namespace}
post
/managed-doc/{namespace}
get
/managed-doc/{namespace}/{slug}
delete
/managed-doc/{namespace}/{slug}
patch
/managed-doc/{namespace}/{slug}
get
/managed-doc/{namespace}/{slug}/version/{semver}
delete
/managed-doc/{namespace}/{slug}/version/{semver}
patch
/managed-doc/{namespace}/{slug}/version/{semver}
get
/managed-doc/{namespace}/{slug}/version/{semver}/metadata
post
/managed-doc/{namespace}/{slug}/version
get
/managed-doc
post
/managed-doc/{namespace}/{slug}/version/{semver}/tools
auth
29
get
/me
post
/login/email
post
/login/email-signup
post
/login/email-otp
post
/login/email-otp/verify
get
/hosting-authenticate
post
/login/refresh
post
/logout
post
/login/exchange
post
/login/get-exchange
post
/login/request-password-reset
post
/login/reset-password
post
/login/change-password
post
/login/personal-token/generate
post
/login/personal-token/access
post
/login/personal-token/{uid}/revoke
delete
/login/personal-token/{uid}
get
/identity-provider/{uid}
delete
/identity-provider/{uid}
post
/identity-provider
post
/identity-provider/update
get
/saml/metadata
get
/saml/idp/{uid}/metadata
get
/saml/idp/{uid}/login
get
/saml/logout
post
/saml/acs
post
/saml/initiate
get
/saml/cert/signing
get
/saml/cert/encryption
docs
6
post
/docs/version
post
/docs/create-project
delete
/docs/delete-project
post
/docs/duplicate
post
/project/update
post
/docs/project/change-privacy
github
19
get
/github/authorize
get
/github/link/initiate
get
/github/repos
get
/github/repos/{id}
get
/github/installs
get
/github/installs/{installationId}/repos
post
/github/link-repo
get
/github/docs-project/{uid}/commits
get
/github/docs-project/{uid}/branches
post
/github/docs-project/{uid}/pull-request
get
/github/docs-project/{uid}/pull-request/for-branch
post
/github/slug/available
post
/github/slug
post
/github/create
post
/github/unlink-repo
post
/github/config/validate
get
/github/{slug}
get
/github/list-projects
post
/github/delete
login-portals
5
get
/login-portals/{slug}
get
/login-portals
post
/login-portals
delete
/login-portals
post
/login-portals/update
payment
3
post
/stripe
post
/payment/start
post
/payment/billing/start
publish
10
post
/publish/dns-check
delete
/unpublish
delete
/publish
post
/publish/redeploy
delete
/publish/bulk
post
/publish/cancel
get
/publish/logs/{publishUid}
post
/publish/domains/availability
post
/publish/domains/project
get
/publish/deploy-check
registry-git
7
patch
/registry-git/{asset}/{namespace}/{slug}/config
get
/registry-git/{asset}/{namespace}/{slug}/history
get
/registry-git/{asset}/{namespace}/{slug}/publishes
post
/registry-git/{asset}/{namespace}/{slug}/publish
post
/registry-git/{asset}/{namespace}/{slug}/provision
post
/registry-git/{asset}/{namespace}/{slug}/link-external
post
/registry-git/{asset}/{namespace}/{slug}/unlink-external
rules
10
get
/rulesets/{namespace}/{slug}
delete
/rulesets/{namespace}/{slug}
patch
/rulesets/{namespace}/{slug}
get
/rulesets/get-by-id/{uid}
get
/rulesets/{namespace}
post
/rulesets/{namespace}
post
/rulesets/upload
post
/rules/access-group
delete
/rules/access-group
post
/rulesets/check-slug
schemas
12
post
/schemas/check-slug
post
/schemas/access-group
delete
/schemas/access-group
get
/schemas/{namespace}
post
/schemas/{namespace}
delete
/schemas/{namespace}/{slug}
patch
/schemas/{namespace}/{slug}
get
/schemas/{namespace}/{slug}/version/{semver}
post
/schemas/{namespace}/{slug}/version/{semver}
delete
/schemas/{namespace}/{slug}/version/{semver}
post
/schemas/{namespace}/{slug}/version
post
/schemas/{namespace}/{slug}/version/{version}/duplicate
sdks
20
post
/v1/sdks/sync
post
/v1/sdks
post
/v1/sdks/version
delete
/v1/sdks/version
delete
/v1/sdks/{uid}
patch
/v1/sdks/{uid}
post
/v1/sdks/bulk
post
/v1/sdks/available
post
/v1/sdks/resolve-config
post
/v1/sdks/{uid}/access-group
delete
/v1/sdks/{uid}/access-group
post
/v1/sdks/repository
delete
/v1/sdks/repository
post
/v1/sdks/repository/update
post
/v1/sdks/repository/publishing
delete
/v1/sdks/{uid}/draft
post
/v1/sdks/{uid}/sample/access
post
/v1/sdks/{uid}/sample/retry
get
/v1/sdks/repository/release-pr
post
/v1/sdks/build
share
1
post
/share/upload/{namespace}
signup
1
post
/signup-data
team
36
get
/me/teams
post
/team/slug
post
/team/slug/available
post
/team/create
post
/team/invite
delete
/team/invite
patch
/team/invite
get
/team/accept-invite
post
/team/rename
post
/team/image
get
/team/leave
delete
/team
post
/team/delete-member
post
/team/update
post
/team/update-user
get
/team/billing
post
/team/billing/email
post
/team/update/plan
post
/team/extend-trial
post
/team/update-role
post
/team/namespace/update
post
/team/namespace
post
/team/namespace/available
get
/team/namespaces
post
/team/onboarding/setup
post
/team/onboarding/complete
post
/team/icon
delete
/team/icon
post
/team/authentication/domain
delete
/team/authentication/domain
post
/team/authentication/method
post
/team/authentication/user
delete
/team/authentication/user
post
/team/authentication/user/method
post
/team/external-access/method
post
/user/update
themes
6
get
/themes/{slug}
put
/themes/{slug}
delete
/themes/{slug}
patch
/themes/{slug}
get
/themes
post
/themes
utility
1
post
/feedback
vcs
6
get
/vcs/bitbucket/authorize
get
/vcs/bitbucket/link/initiate
get
/vcs/bitbucket/workspaces
get
/vcs/bitbucket/docs-project/{uid}/branches
post
/vcs/bitbucket/disconnect-account
post
/vcs/github/disconnect-account
waitlist
1
post
/waitlist
workspace
8
post
/workspaces/{namespace}
delete
/workspaces/{namespace}/{slug}
patch
/workspaces/{namespace}/{slug}
post
/workspaces/{namespace}/{slug}/version
post
/workspaces/{namespace}/{slug}/access/{group}
delete
/workspaces/{namespace}/{slug}/access/{group}
get
/workspaces/{namespace}/{slug}/available
delete
/workspaces/{namespace}/{slug}/version/{version}
get
/forgejo/git-credentials
post
/docs-projects/create
delete
/docs-projects/delete
get
/docs-projects/{slug}
post
/docs-projects/update-repo-settings
post
/docs-projects/{projectUid}/link-github
post
/docs-projects/{projectUid}/unlink-github
post
/docs-projects/{projectUid}/link-bitbucket
post
/docs-projects/{projectUid}/unlink-bitbucket
post
/docs-projects/{projectUid}/bitbucket/refresh-webhook
auth
Get a users basic information
get
/me
Response
Default Response
User
required
uid
string
required
createdAt
integer
required
updatedAt
integer
required
theme
string
userIndex
string
required
email
string
email
required
teams
TeamRef[]
required
activeTeamId
string
nullable
required
hasGithub
boolean
required
hasBitbucket
boolean
required
forgejoToken
string