API reference
This read-only reference is generated from the selected application release. Use the search field to find an endpoint; expand schema details for nested fields and download the complete OpenAPI JSON when needed.
For the documentation served by your installation, see API access.
114 endpoints
health
GET/api/health
Get application health status
Authentication
No authentication required by this contract.
Responses
200 The API process, database, and persisted provider synchronization state.
auth
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
PATCH/api/v1/auth/me
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonUpdateProfileDto · objectProperties
Schema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
multipart/form-dataobjectProperties
Schema JSON
Responses
200
DELETE/api/v1/auth/me/avatar
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonRemoteAvatarDto · objectProperties
Schema JSON
Responses
201
Authentication
No authentication required by this contract.
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonUpdateOidcConfigDto · objectProperties
Schema JSON
Responses
200
Authentication
No authentication required by this contract.
Request body
application/jsonOidcExchangeDto · objectProperties
Schema JSON
Responses
200
Authentication
No authentication required by this contract.
Parameters
return_toRequiredstringSchema JSON
Responses
200
Authentication
No authentication required by this contract.
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonUpdatePasswordDto · objectProperties
Schema JSON
Responses
201
Authentication
No authentication required by this contract.
Request body
application/jsonSetupDto · objectProperties
Schema JSON
Responses
200
Authentication
No authentication required by this contract.
Responses
200
Authentication
No authentication required by this contract.
Request body
application/jsonSignInDto · objectProperties
Schema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
204
notifications
GET/api/v1/browser-push
Get browser-push availability and enrollment status
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonRegisterBrowserPushSubscriptionDto · objectProperties
Schema JSON
Responses
204
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonRemoveBrowserPushSubscriptionDto · objectProperties
Schema JSON
Responses
204
GET/api/v1/notification-channels
List visible notification channels
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
POST/api/v1/notification-channels
Create a notification channel
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonCreateNotificationChannelDto · objectProperties
Schema JSON
Responses
200
PATCH/api/v1/notification-channels/{id}
Update a notification channel
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Request body
application/jsonUpdateNotificationChannelDto · objectProperties
Schema JSON
Responses
200
DELETE/api/v1/notification-channels/{id}
Delete a notification channel
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
204
POST/api/v1/notification-channels/{id}/test
Test one notification channel
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
POST/api/v1/notification-channels/preview
Preview workflow notification subscriptions
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonNotificationRulePreviewInputDto · objectProperties
Schema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereNotificationChannelWhere · objectProperties
Schema JSON
orderByanyOfNotificationChannelOrderBy · objectProperties
arrayNotificationChannelOrderBy · objectProperties
Schema JSON
selectNotificationChannelSelect · objectProperties
Schema JSON
includeNotificationChannelInclude · objectProperties
Schema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","name","type","enabled"]
arraystring["id","createdAt","updatedAt","name","type","enabled"]
Schema JSON
searchstringSchema JSON
Responses
200 Visible notification channels.
GET/api/v1/notification-deliveries
List visible notification delivery history
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
repositoryIdRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereNotificationDeliveryWhere · objectProperties
Schema JSON
orderByanyOfNotificationDeliveryOrderBy · objectProperties
arrayNotificationDeliveryOrderBy · objectProperties
Schema JSON
selectNotificationDeliverySelect · objectProperties
Schema JSON
includeNotificationDeliveryInclude · objectProperties
Schema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","kind","eventType","status","nextAttemptAt","notificationChannelId","repositoryId"]
arraystring["id","createdAt","updatedAt","kind","eventType","status","nextAttemptAt","notificationChannelId","repositoryId"]
Schema JSON
searchstringSchema JSON
Responses
200 Authorized notification delivery history.
dashboard
GET/api/v1/dashboard/awaiting-approval
List workflow runs awaiting provider approval
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200 Visible workflow runs awaiting approval.
GET/api/v1/dashboard/failures
List the 15 newest workflow contexts whose latest terminal run failed
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200 Visible latest failed workflow runs.
GET/api/v1/dashboard/latest-runs
List the ten newest visible workflow runs
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200 The ten newest visible workflow runs.
GET/api/v1/dashboard/repositories
Get visible repository workflow health
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
fromRequiredstringSchema JSON
toRequiredstringSchema JSON
Responses
200 Permission-aware repository health aggregates.
GET/api/v1/dashboard/summary
Get visible workflow health summary
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
fromRequiredstringSchema JSON
toRequiredstringSchema JSON
Responses
200 Permission-aware workflow health summary.
GET/api/v1/dashboard/trend
Get success and error workflow-run trend buckets
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
fromRequiredstringSchema JSON
toRequiredstringSchema JSON
bucketanyOfstring["hour"]
string["day"]
string["week"]
Schema JSON
Responses
200 Visible workflow-run trend buckets.
GitHubApp
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonSaveGitHubAppDto · objectProperties
Schema JSON
Responses
200
DELETE/api/v1/github-app
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
204
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonConnectGitHubAppDto · objectProperties
Schema JSON
Responses
201
issues
GET/api/v1/issues
Query visible issues
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereIssueWhere · objectProperties
Schema JSON
orderByanyOfIssueOrderBy · objectProperties
arrayIssueOrderBy · objectProperties
Schema JSON
selectIssueSelect · objectProperties
Schema JSON
includeIssueInclude · objectProperties
Schema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","number","title","body","state","url","providerCreatedAt","providerUpdatedAt","closedAt","milestone","repositoryId"]
arraystring["id","createdAt","updatedAt","number","title","body","state","url","providerCreatedAt","providerUpdatedAt","closedAt","milestone","repositoryId"]
Schema JSON
searchstringnullableSchema JSON
labelsnullableanyOfstringarraystringSchema JSON
Responses
200 Visible provider issues.
400 Invalid issue query.
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
jobs
GET/api/v1/jobs/repository-sync
Query visible repository synchronization jobs
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereRepositoryWhere · objectProperties
Schema JSON
orderByanyOfRepositoryOrderBy · objectProperties
arrayRepositoryOrderBy · objectProperties
Schema JSON
selectRepositorySelect · objectProperties
Schema JSON
includeRepositoryInclude · objectProperties
Schema JSON
cursorobjectProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","providerRepositoryId","owner","name","url","enabled","lastSyncAt","providerAccountId","workflowRunRetentionDays","issueRetentionDays","pullRequestRetentionDays"]
arraystring["id","createdAt","updatedAt","providerRepositoryId","owner","name","url","enabled","lastSyncAt","providerAccountId","workflowRunRetentionDays","issueRetentionDays","pullRequestRetentionDays"]
Schema JSON
searchstringSchema JSON
Responses
200 Visible repository synchronization jobs.
400 Invalid repository synchronization job query.
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
repositoryIdRequiredstringSchema JSON
Responses
202
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
202
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
mcp-tokens
GET/api/v1/mcp-tokens
List safe MCP token metadata
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
userIdstring · uuidnullableSchema JSON
Responses
200
POST/api/v1/mcp-tokens
Create a user-owned MCP token
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonCreateMcpAccessTokenDto · objectProperties
Schema JSON
Responses
201
DELETE/api/v1/mcp-tokens/{id}
Revoke an MCP token
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
204
ProviderAccounts
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereProviderAccountWhere · objectProperties
Schema JSON
orderByanyOfProviderAccountOrderBy · objectProperties
arrayProviderAccountOrderBy · objectProperties
Schema JSON
selectProviderAccountSelect · objectProperties
Schema JSON
includeProviderAccountInclude · objectProperties
Schema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["authenticationMethod","githubInstallationState","id","createdAt","updatedAt","providerType","displayName","baseUrl","enabled","lastSyncAt"]
arraystring["authenticationMethod","githubInstallationState","id","createdAt","updatedAt","providerType","displayName","baseUrl","enabled","lastSyncAt"]
Schema JSON
searchstringSchema JSON
Responses
200 Configured provider accounts.
400 Invalid provider-account query.
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonCreateProviderAccountDto · objectProperties
Schema JSON
Responses
201
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Request body
application/jsonUpdateProviderAccountDto · objectProperties
Schema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
204
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Request body
application/jsonCreateTrackedRepositoryDto · objectProperties
Schema JSON
Responses
201
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonStartProviderOAuthDto · objectProperties
Schema JSON
Responses
201
ProviderOAuth
Authentication
No authentication required by this contract.
Parameters
stateRequiredstringSchema JSON
codestringnullableSchema JSON
errorstringnullableSchema JSON
error_descriptionstringnullableSchema JSON
error_uristringnullableSchema JSON
Responses
200
pull-requests
GET/api/v1/pull-requests
Query visible pull requests
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
wherePullRequestWhere · objectProperties
Schema JSON
orderByanyOfPullRequestOrderBy · objectProperties
arrayPullRequestOrderBy · objectProperties
Schema JSON
selectPullRequestSelect · objectProperties
Schema JSON
includePullRequestInclude · objectProperties
Schema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","number","title","body","state","draft","sourceBranch","targetBranch","url","providerCreatedAt","providerUpdatedAt","closedAt","mergedAt","workflowStatus","workflowApprovalRequired","repositoryId"]
arraystring["id","createdAt","updatedAt","number","title","body","state","draft","sourceBranch","targetBranch","url","providerCreatedAt","providerUpdatedAt","closedAt","mergedAt","workflowStatus","workflowApprovalRequired","repositoryId"]
Schema JSON
searchstringnullableSchema JSON
labelsnullableanyOfstringarraystringSchema JSON
Responses
200 Visible provider pull requests.
400 Invalid pull-request query.
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Repositories
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereRepositoryWhere · objectProperties
Schema JSON
orderByanyOfRepositoryOrderBy · objectProperties
arrayRepositoryOrderBy · objectProperties
Schema JSON
selectRepositorySelect · objectProperties
Schema JSON
includeRepositoryInclude · objectProperties
Schema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","providerRepositoryId","owner","name","url","enabled","lastSyncAt","providerAccountId","workflowRunRetentionDays","issueRetentionDays","pullRequestRetentionDays"]
arraystring["id","createdAt","updatedAt","providerRepositoryId","owner","name","url","enabled","lastSyncAt","providerAccountId","workflowRunRetentionDays","issueRetentionDays","pullRequestRetentionDays"]
Schema JSON
searchstringSchema JSON
Responses
200 Tracked repositories.
400 Invalid repository query.
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Request body
application/jsonUpdateRepositoryDto · objectProperties
Schema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
userIdRequiredstringSchema JSON
Request body
application/jsonUpsertRepositoryMembershipDto · objectProperties
Schema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
userIdRequiredstringSchema JSON
Responses
204
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Request body
application/jsonSetRepositoryWebhookSecretDto · objectProperties
Schema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
204
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Request body
application/jsonCreateWorkflowFilterDto · objectProperties
Schema JSON
Responses
201
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
filterIdRequiredstringSchema JSON
Responses
204
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
RepositoryRefresh
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
201
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
202
RepositoryGroups
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
repositoryIdRequiredstringSchema JSON
Responses
200
400
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
repositoryIdRequiredstringSchema JSON
groupIdRequiredstringSchema JSON
Request body
application/jsonSaveRepositoryGroupDto · objectProperties
Schema JSON
Responses
200
400
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
repositoryIdRequiredstringSchema JSON
groupIdRequiredstringSchema JSON
Responses
204
400
401
403
security-alerts
GET/api/v1/security-alerts
Query visible security alerts
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereSecurityAlertWhere · objectProperties
Schema JSON
orderByanyOfSecurityAlertOrderBy · objectProperties
arraySecurityAlertOrderBy · objectProperties
Schema JSON
selectSecurityAlertSelect · objectProperties
Schema JSON
includeSecurityAlertInclude · objectProperties
Schema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","kind","state","severity","title","scanner","providerCreatedAt","providerUpdatedAt","resolvedAt","resolution","packageName","ecosystem","manifest","ruleId","tool","secretType","secretProvider","repositoryId"]
arraystring["id","createdAt","updatedAt","kind","state","severity","title","scanner","providerCreatedAt","providerUpdatedAt","resolvedAt","resolution","packageName","ecosystem","manifest","ruleId","tool","secretType","secretProvider","repositoryId"]
Schema JSON
searchstringSchema JSON
Responses
200 Visible normalized security alerts.
400 Invalid security-alert query.
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
settings
GET/api/v1/settings
Get global application settings
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
PATCH/api/v1/settings
Update global application settings
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonUpdateApplicationSettingsDto · objectProperties
Schema JSON
Responses
200
403 System administrator access is required.
UserGroups
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereUserGroupWhere · objectProperties
Schema JSON
orderByanyOfUserGroupOrderBy · objectProperties
arrayUserGroupOrderBy · objectProperties
Schema JSON
selectUserGroupSelect · objectProperties
Schema JSON
includeUserGroupInclude · objectSchema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","name","createdAt","updatedAt"]
arraystring["id","name","createdAt","updatedAt"]
Schema JSON
Responses
200
400
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonSaveUserGroupDto · objectProperties
Schema JSON
Responses
200
400
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Request body
application/jsonSaveUserGroupDto · objectProperties
Schema JSON
Responses
200
400
401
403
DELETE/api/v1/user-groups/{id}
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
204
400
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereUserWhere · objectProperties
Schema JSON
orderByanyOfUserOrderBy · objectProperties
arrayUserOrderBy · objectProperties
Schema JSON
selectUserSelect · objectProperties
Schema JSON
includeUserInclude · objectSchema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]
arraystring["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]
Schema JSON
Responses
200
400
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
userIdRequiredstringSchema JSON
Responses
204
400
401
403
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
userIdRequiredstringSchema JSON
Responses
204
400
401
403
Users
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereUserWhere · objectProperties
Schema JSON
orderByanyOfUserOrderBy · objectProperties
arrayUserOrderBy · objectProperties
Schema JSON
selectUserSelect · objectProperties
Schema JSON
includeUserInclude · objectSchema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]
arraystring["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]
Schema JSON
Responses
200 System users.
400 Invalid user query.
401
403
POST/api/v1/users
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Request body
application/jsonCreateUserDto · objectProperties
Schema JSON
Responses
201
DELETE/api/v1/users/{id}
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Responses
200
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
idRequiredstringSchema JSON
Request body
application/jsonResetUserPasswordDto · objectProperties
Schema JSON
Responses
204
400
401
403
404 User not found.
version
GET/api/v1/version/latest
Get the latest released Repovio version
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Responses
200
webhooks
POST/api/v1/webhooks/forgejo/{repositoryId}
Accept a signed Forgejo webhook delivery
Authentication
No authentication required by this contract.
Parameters
repositoryIdRequiredstring · uuidSchema JSON
Responses
202 The delivery was accepted for asynchronous synchronization.
POST/api/v1/webhooks/gitea/{repositoryId}
Accept a signed Gitea webhook delivery
Authentication
No authentication required by this contract.
Parameters
repositoryIdRequiredstring · uuidSchema JSON
Responses
202 The delivery was accepted for asynchronous synchronization.
POST/api/v1/webhooks/github-app
Accept a signed GitHub App delivery
Authentication
No authentication required by this contract.
Responses
202 The App delivery was durably accepted.
POST/api/v1/webhooks/github/{repositoryId}
Accept a signed GitHub webhook delivery
Authentication
No authentication required by this contract.
Parameters
repositoryIdRequiredstring · uuidSchema JSON
Responses
202 The delivery was accepted for asynchronous synchronization.
POST/api/v1/webhooks/gitlab/{repositoryId}
Accept a signed GitLab webhook delivery
Authentication
No authentication required by this contract.
Parameters
repositoryIdRequiredstring · uuidSchema JSON
Responses
202 The delivery was accepted for asynchronous synchronization.
POST/api/webhooks/forgejo/{repositoryId}
Accept a signed Forgejo webhook delivery
Authentication
No authentication required by this contract.
Parameters
repositoryIdRequiredstring · uuidSchema JSON
Responses
202 The delivery was accepted for asynchronous synchronization.
POST/api/webhooks/gitea/{repositoryId}
Accept a signed Gitea webhook delivery
Authentication
No authentication required by this contract.
Parameters
repositoryIdRequiredstring · uuidSchema JSON
Responses
202 The delivery was accepted for asynchronous synchronization.
POST/api/webhooks/github-app
Accept a signed GitHub App delivery
Authentication
No authentication required by this contract.
Responses
202 The App delivery was durably accepted.
POST/api/webhooks/github/{repositoryId}
Accept a signed GitHub webhook delivery
Authentication
No authentication required by this contract.
Parameters
repositoryIdRequiredstring · uuidSchema JSON
Responses
202 The delivery was accepted for asynchronous synchronization.
POST/api/webhooks/gitlab/{repositoryId}
Accept a signed GitLab webhook delivery
Authentication
No authentication required by this contract.
Parameters
repositoryIdRequiredstring · uuidSchema JSON
Responses
202 The delivery was accepted for asynchronous synchronization.
workflow-runs
GET/api/v1/workflow-runs
Query visible workflow runs
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereWorkflowRunWhere · objectProperties
Schema JSON
orderByanyOfWorkflowRunOrderBy · objectProperties
arrayWorkflowRunOrderBy · objectProperties
Schema JSON
selectWorkflowRunSelect · objectProperties
Schema JSON
includeWorkflowRunInclude · objectProperties
Schema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","providerRunId","workflowName","displayTitle","url","providerCreatedAt","startedAt","completedAt","durationMs","status","awaitingApproval","event","scopeKey","workflowId","repositoryId"]
arraystring["id","createdAt","updatedAt","providerRunId","workflowName","displayTitle","url","providerCreatedAt","startedAt","completedAt","durationMs","status","awaitingApproval","event","scopeKey","workflowId","repositoryId"]
Schema JSON
searchstringSchema JSON
Responses
200 Visible workflow runs.
400 Invalid workflow-run query.
401
403
GET/api/v1/workflow-runs/needs-attention
Query visible workflow runs that need attention
Authentication
- Alternative 1 (all listed schemes required)
bearer · http · bearer
Parameters
pageanyOfnumberstringSchema JSON
perPageanyOfnumberstringSchema JSON
fieldsstringSchema JSON
whereWorkflowRunWhere · objectProperties
Schema JSON
orderByanyOfWorkflowRunOrderBy · objectProperties
arrayWorkflowRunOrderBy · objectProperties
Schema JSON
selectWorkflowRunSelect · objectProperties
Schema JSON
includeWorkflowRunInclude · objectProperties
Schema JSON
cursorstringProperties
Schema JSON
distinctanyOfstring["id","createdAt","updatedAt","providerRunId","workflowName","displayTitle","url","providerCreatedAt","startedAt","completedAt","durationMs","status","awaitingApproval","event","scopeKey","workflowId","repositoryId"]
arraystring["id","createdAt","updatedAt","providerRunId","workflowName","displayTitle","url","providerCreatedAt","startedAt","completedAt","durationMs","status","awaitingApproval","event","scopeKey","workflowId","repositoryId"]
Schema JSON
searchstring