Referência da API
Essa referência somente leitura é gerada a partir da versão do aplicativo selecionada. Use o campo de pesquisa para encontrar um endpoint; expanda os detalhes do esquema para campos aninhados e baixe o JSON OpenAPI completo quando necessário.
Para obter a documentação fornecida pela sua instalação, consulte Acesso à API.
Extremidades 114
health
GET/api/health
Get application health status
Autenticação
Nenhuma autenticação exigida por este contrato.
Respostas
200 The API process, database, and persisted provider synchronization state.
auth
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
PATCH/api/v1/auth/me
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonUpdateProfileDto · objectPropriedades
Esquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
multipart/form-dataobjectPropriedades
Esquema JSON
Respostas
200
DELETE/api/v1/auth/me/avatar
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonRemoteAvatarDto · objectPropriedades
Esquema JSON
Respostas
201
Autenticação
Nenhuma autenticação exigida por este contrato.
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonUpdateOidcConfigDto · objectPropriedades
Esquema JSON
Respostas
200
Autenticação
Nenhuma autenticação exigida por este contrato.
Solicitar corpo
application/jsonOidcExchangeDto · objectPropriedades
Esquema JSON
Respostas
200
Autenticação
Nenhuma autenticação exigida por este contrato.
Parâmetros
return_toObrigatóriostringEsquema JSON
Respostas
200
Autenticação
Nenhuma autenticação exigida por este contrato.
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonUpdatePasswordDto · objectPropriedades
Esquema JSON
Respostas
201
Autenticação
Nenhuma autenticação exigida por este contrato.
Solicitar corpo
application/jsonSetupDto · objectPropriedades
Esquema JSON
Respostas
200
Autenticação
Nenhuma autenticação exigida por este contrato.
Respostas
200
Autenticação
Nenhuma autenticação exigida por este contrato.
Solicitar corpo
application/jsonSignInDto · objectPropriedades
Esquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
204
notifications
GET/api/v1/browser-push
Get browser-push availability and enrollment status
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonRegisterBrowserPushSubscriptionDto · objectPropriedades
Esquema JSON
Respostas
204
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonRemoveBrowserPushSubscriptionDto · objectPropriedades
Esquema JSON
Respostas
204
GET/api/v1/notification-channels
List visible notification channels
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
POST/api/v1/notification-channels
Create a notification channel
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonCreateNotificationChannelDto · objectPropriedades
Esquema JSON
Respostas
200
PATCH/api/v1/notification-channels/{id}
Update a notification channel
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Solicitar corpo
application/jsonUpdateNotificationChannelDto · objectPropriedades
Esquema JSON
Respostas
200
DELETE/api/v1/notification-channels/{id}
Delete a notification channel
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
204
POST/api/v1/notification-channels/{id}/test
Test one notification channel
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
POST/api/v1/notification-channels/preview
Preview workflow notification subscriptions
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonNotificationRulePreviewInputDto · objectPropriedades
Esquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereNotificationChannelWhere · objectPropriedades
Esquema JSON
orderByanyOfNotificationChannelOrderBy · objectPropriedades
arrayNotificationChannelOrderBy · objectPropriedades
Esquema JSON
selectNotificationChannelSelect · objectPropriedades
Esquema JSON
includeNotificationChannelInclude · objectPropriedades
Esquema JSON
cursorstringPropriedades
Esquema JSON
distinctanyOfstring["id","createdAt","updatedAt","name","type","enabled"]
arraystring["id","createdAt","updatedAt","name","type","enabled"]
Esquema JSON
searchstringEsquema JSON
Respostas
200 Visible notification channels.
GET/api/v1/notification-deliveries
List visible notification delivery history
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
repositoryIdObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereNotificationDeliveryWhere · objectPropriedades
Esquema JSON
orderByanyOfNotificationDeliveryOrderBy · objectPropriedades
arrayNotificationDeliveryOrderBy · objectPropriedades
Esquema JSON
selectNotificationDeliverySelect · objectPropriedades
Esquema JSON
includeNotificationDeliveryInclude · objectPropriedades
Esquema JSON
cursorstringPropriedades
Esquema JSON
distinctanyOfstring["id","createdAt","updatedAt","kind","eventType","status","nextAttemptAt","notificationChannelId","repositoryId"]
arraystring["id","createdAt","updatedAt","kind","eventType","status","nextAttemptAt","notificationChannelId","repositoryId"]
Esquema JSON
searchstringEsquema JSON
Respostas
200 Authorized notification delivery history.
dashboard
GET/api/v1/dashboard/awaiting-approval
List workflow runs awaiting provider approval
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200 Visible workflow runs awaiting approval.
GET/api/v1/dashboard/failures
List the 15 newest workflow contexts whose latest terminal run failed
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200 Visible latest failed workflow runs.
GET/api/v1/dashboard/latest-runs
List the ten newest visible workflow runs
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200 The ten newest visible workflow runs.
GET/api/v1/dashboard/repositories
Get visible repository workflow health
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
fromObrigatóriostringEsquema JSON
toObrigatóriostringEsquema JSON
Respostas
200 Permission-aware repository health aggregates.
GET/api/v1/dashboard/summary
Get visible workflow health summary
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
fromObrigatóriostringEsquema JSON
toObrigatóriostringEsquema JSON
Respostas
200 Permission-aware workflow health summary.
GET/api/v1/dashboard/trend
Get success and error workflow-run trend buckets
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
fromObrigatóriostringEsquema JSON
toObrigatóriostringEsquema JSON
bucketanyOfstring["hour"]
string["day"]
string["week"]
Esquema JSON
Respostas
200 Visible workflow-run trend buckets.
GitHubApp
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonSaveGitHubAppDto · objectPropriedades
Esquema JSON
Respostas
200
DELETE/api/v1/github-app
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
204
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonConnectGitHubAppDto · objectPropriedades
Esquema JSON
Respostas
201
issues
GET/api/v1/issues
Query visible issues
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereIssueWhere · objectPropriedades
Esquema JSON
orderByanyOfIssueOrderBy · objectPropriedades
arrayIssueOrderBy · objectPropriedades
Esquema JSON
selectIssueSelect · objectPropriedades
Esquema JSON
includeIssueInclude · objectPropriedades
Esquema JSON
cursorstringPropriedades
Esquema 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"]
Esquema JSON
searchstringnullableEsquema JSON
labelsnullableanyOfstringarraystringEsquema JSON
Respostas
200 Visible provider issues.
400 Invalid issue query.
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
jobs
GET/api/v1/jobs/repository-sync
Query visible repository synchronization jobs
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereRepositoryWhere · objectPropriedades
Esquema JSON
orderByanyOfRepositoryOrderBy · objectPropriedades
arrayRepositoryOrderBy · objectPropriedades
Esquema JSON
selectRepositorySelect · objectPropriedades
Esquema JSON
includeRepositoryInclude · objectPropriedades
Esquema JSON
cursorobjectPropriedades
Esquema 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"]
Esquema JSON
searchstringEsquema JSON
Respostas
200 Visible repository synchronization jobs.
400 Invalid repository synchronization job query.
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
repositoryIdObrigatóriostringEsquema JSON
Respostas
202
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
202
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
mcp-tokens
GET/api/v1/mcp-tokens
List safe MCP token metadata
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
userIdstring · uuidnullableEsquema JSON
Respostas
200
POST/api/v1/mcp-tokens
Create a user-owned MCP token
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonCreateMcpAccessTokenDto · objectPropriedades
Esquema JSON
Respostas
201
DELETE/api/v1/mcp-tokens/{id}
Revoke an MCP token
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
204
ProviderAccounts
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereProviderAccountWhere · objectPropriedades
Esquema JSON
orderByanyOfProviderAccountOrderBy · objectPropriedades
arrayProviderAccountOrderBy · objectPropriedades
Esquema JSON
selectProviderAccountSelect · objectPropriedades
Esquema JSON
includeProviderAccountInclude · objectPropriedades
Esquema JSON
cursorstringPropriedades
Esquema JSON
distinctanyOfstring["authenticationMethod","githubInstallationState","id","createdAt","updatedAt","providerType","displayName","baseUrl","enabled","lastSyncAt"]
arraystring["authenticationMethod","githubInstallationState","id","createdAt","updatedAt","providerType","displayName","baseUrl","enabled","lastSyncAt"]
Esquema JSON
searchstringEsquema JSON
Respostas
200 Configured provider accounts.
400 Invalid provider-account query.
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonCreateProviderAccountDto · objectPropriedades
Esquema JSON
Respostas
201
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Solicitar corpo
application/jsonUpdateProviderAccountDto · objectPropriedades
Esquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
204
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Solicitar corpo
application/jsonCreateTrackedRepositoryDto · objectPropriedades
Esquema JSON
Respostas
201
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonStartProviderOAuthDto · objectPropriedades
Esquema JSON
Respostas
201
ProviderOAuth
Autenticação
Nenhuma autenticação exigida por este contrato.
Parâmetros
stateObrigatóriostringEsquema JSON
codestringnullableEsquema JSON
errorstringnullableEsquema JSON
error_descriptionstringnullableEsquema JSON
error_uristringnullableEsquema JSON
Respostas
200
pull-requests
GET/api/v1/pull-requests
Query visible pull requests
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
wherePullRequestWhere · objectPropriedades
Esquema JSON
orderByanyOfPullRequestOrderBy · objectPropriedades
arrayPullRequestOrderBy · objectPropriedades
Esquema JSON
selectPullRequestSelect · objectPropriedades
Esquema JSON
includePullRequestInclude · objectPropriedades
Esquema JSON
cursorstringPropriedades
Esquema 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"]
Esquema JSON
searchstringnullableEsquema JSON
labelsnullableanyOfstringarraystringEsquema JSON
Respostas
200 Visible provider pull requests.
400 Invalid pull-request query.
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Repositories
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereRepositoryWhere · objectPropriedades
Esquema JSON
orderByanyOfRepositoryOrderBy · objectPropriedades
arrayRepositoryOrderBy · objectPropriedades
Esquema JSON
selectRepositorySelect · objectPropriedades
Esquema JSON
includeRepositoryInclude · objectPropriedades
Esquema JSON
cursorstringPropriedades
Esquema 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"]
Esquema JSON
searchstringEsquema JSON
Respostas
200 Tracked repositories.
400 Invalid repository query.
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Solicitar corpo
application/jsonUpdateRepositoryDto · objectPropriedades
Esquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
userIdObrigatóriostringEsquema JSON
Solicitar corpo
application/jsonUpsertRepositoryMembershipDto · objectPropriedades
Esquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
userIdObrigatóriostringEsquema JSON
Respostas
204
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Solicitar corpo
application/jsonSetRepositoryWebhookSecretDto · objectPropriedades
Esquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
204
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Solicitar corpo
application/jsonCreateWorkflowFilterDto · objectPropriedades
Esquema JSON
Respostas
201
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
filterIdObrigatóriostringEsquema JSON
Respostas
204
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
RepositoryRefresh
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
201
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
202
RepositoryGroups
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
repositoryIdObrigatóriostringEsquema JSON
Respostas
200
400
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
repositoryIdObrigatóriostringEsquema JSON
groupIdObrigatóriostringEsquema JSON
Solicitar corpo
application/jsonSaveRepositoryGroupDto · objectPropriedades
Esquema JSON
Respostas
200
400
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
repositoryIdObrigatóriostringEsquema JSON
groupIdObrigatóriostringEsquema JSON
Respostas
204
400
401
403
security-alerts
GET/api/v1/security-alerts
Query visible security alerts
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereSecurityAlertWhere · objectPropriedades
Esquema JSON
orderByanyOfSecurityAlertOrderBy · objectPropriedades
arraySecurityAlertOrderBy · objectPropriedades
Esquema JSON
selectSecurityAlertSelect · objectPropriedades
Esquema JSON
includeSecurityAlertInclude · objectPropriedades
Esquema JSON
cursorstringPropriedades
Esquema 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"]
Esquema JSON
searchstringEsquema JSON
Respostas
200 Visible normalized security alerts.
400 Invalid security-alert query.
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
settings
GET/api/v1/settings
Get global application settings
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
PATCH/api/v1/settings
Update global application settings
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonUpdateApplicationSettingsDto · objectPropriedades
Esquema JSON
Respostas
200
403 System administrator access is required.
UserGroups
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereUserGroupWhere · objectPropriedades
Esquema JSON
orderByanyOfUserGroupOrderBy · objectPropriedades
arrayUserGroupOrderBy · objectPropriedades
Esquema JSON
selectUserGroupSelect · objectPropriedades
Esquema JSON
includeUserGroupInclude · objectEsquema JSON
cursorstringPropriedades
Esquema JSON
distinctanyOfstring["id","name","createdAt","updatedAt"]
arraystring["id","name","createdAt","updatedAt"]
Esquema JSON
Respostas
200
400
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonSaveUserGroupDto · objectPropriedades
Esquema JSON
Respostas
200
400
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Solicitar corpo
application/jsonSaveUserGroupDto · objectPropriedades
Esquema JSON
Respostas
200
400
401
403
DELETE/api/v1/user-groups/{id}
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
204
400
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereUserWhere · objectPropriedades
Esquema JSON
orderByanyOfUserOrderBy · objectPropriedades
arrayUserOrderBy · objectPropriedades
Esquema JSON
selectUserSelect · objectPropriedades
Esquema JSON
includeUserInclude · objectEsquema JSON
cursorstringPropriedades
Esquema JSON
distinctanyOfstring["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]
arraystring["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]
Esquema JSON
Respostas
200
400
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
userIdObrigatóriostringEsquema JSON
Respostas
204
400
401
403
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
userIdObrigatóriostringEsquema JSON
Respostas
204
400
401
403
Users
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereUserWhere · objectPropriedades
Esquema JSON
orderByanyOfUserOrderBy · objectPropriedades
arrayUserOrderBy · objectPropriedades
Esquema JSON
selectUserSelect · objectPropriedades
Esquema JSON
includeUserInclude · objectEsquema JSON
cursorstringPropriedades
Esquema JSON
distinctanyOfstring["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]
arraystring["id","createdAt","updatedAt","username","firstName","lastName","authProvider","role"]
Esquema JSON
Respostas
200 System users.
400 Invalid user query.
401
403
POST/api/v1/users
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Solicitar corpo
application/jsonCreateUserDto · objectPropriedades
Esquema JSON
Respostas
201
DELETE/api/v1/users/{id}
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Respostas
200
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
idObrigatóriostringEsquema JSON
Solicitar corpo
application/jsonResetUserPasswordDto · objectPropriedades
Esquema JSON
Respostas
204
400
401
403
404 User not found.
version
GET/api/v1/version/latest
Get the latest released Repovio version
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Respostas
200
webhooks
POST/api/v1/webhooks/forgejo/{repositoryId}
Accept a signed Forgejo webhook delivery
Autenticação
Nenhuma autenticação exigida por este contrato.
Parâmetros
repositoryIdObrigatóriostring · uuidEsquema JSON
Respostas
202 The delivery was accepted for asynchronous synchronization.
POST/api/v1/webhooks/gitea/{repositoryId}
Accept a signed Gitea webhook delivery
Autenticação
Nenhuma autenticação exigida por este contrato.
Parâmetros
repositoryIdObrigatóriostring · uuidEsquema JSON
Respostas
202 The delivery was accepted for asynchronous synchronization.
POST/api/v1/webhooks/github-app
Accept a signed GitHub App delivery
Autenticação
Nenhuma autenticação exigida por este contrato.
Respostas
202 The App delivery was durably accepted.
POST/api/v1/webhooks/github/{repositoryId}
Accept a signed GitHub webhook delivery
Autenticação
Nenhuma autenticação exigida por este contrato.
Parâmetros
repositoryIdObrigatóriostring · uuidEsquema JSON
Respostas
202 The delivery was accepted for asynchronous synchronization.
POST/api/v1/webhooks/gitlab/{repositoryId}
Accept a signed GitLab webhook delivery
Autenticação
Nenhuma autenticação exigida por este contrato.
Parâmetros
repositoryIdObrigatóriostring · uuidEsquema JSON
Respostas
202 The delivery was accepted for asynchronous synchronization.
POST/api/webhooks/forgejo/{repositoryId}
Accept a signed Forgejo webhook delivery
Autenticação
Nenhuma autenticação exigida por este contrato.
Parâmetros
repositoryIdObrigatóriostring · uuidEsquema JSON
Respostas
202 The delivery was accepted for asynchronous synchronization.
POST/api/webhooks/gitea/{repositoryId}
Accept a signed Gitea webhook delivery
Autenticação
Nenhuma autenticação exigida por este contrato.
Parâmetros
repositoryIdObrigatóriostring · uuidEsquema JSON
Respostas
202 The delivery was accepted for asynchronous synchronization.
POST/api/webhooks/github-app
Accept a signed GitHub App delivery
Autenticação
Nenhuma autenticação exigida por este contrato.
Respostas
202 The App delivery was durably accepted.
POST/api/webhooks/github/{repositoryId}
Accept a signed GitHub webhook delivery
Autenticação
Nenhuma autenticação exigida por este contrato.
Parâmetros
repositoryIdObrigatóriostring · uuidEsquema JSON
Respostas
202 The delivery was accepted for asynchronous synchronization.
POST/api/webhooks/gitlab/{repositoryId}
Accept a signed GitLab webhook delivery
Autenticação
Nenhuma autenticação exigida por este contrato.
Parâmetros
repositoryIdObrigatóriostring · uuidEsquema JSON
Respostas
202 The delivery was accepted for asynchronous synchronization.
workflow-runs
GET/api/v1/workflow-runs
Query visible workflow runs
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereWorkflowRunWhere · objectPropriedades
Esquema JSON
orderByanyOfWorkflowRunOrderBy · objectPropriedades
arrayWorkflowRunOrderBy · objectPropriedades
Esquema JSON
selectWorkflowRunSelect · objectPropriedades
Esquema JSON
includeWorkflowRunInclude · objectPropriedades
Esquema JSON
cursorstringPropriedades
Esquema 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"]
Esquema JSON
searchstringEsquema JSON
Respostas
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
Autenticação
- Alternativa 1 (todos os esquemas listados são necessários)
bearer · http · bearer
Parâmetros
pageanyOfnumberstringEsquema JSON
perPageanyOfnumberstringEsquema JSON
fieldsstringEsquema JSON
whereWorkflowRunWhere · objectPropriedades
Esquema JSON
orderByanyOfWorkflowRunOrderBy · objectPropriedades
arrayWorkflowRunOrderBy · objectPropriedades
Esquema JSON
selectWorkflowRunSelect · objectPropriedades
Esquema JSON
includeWorkflowRunInclude · objectPropriedades
Esquema JSON
cursorstringPropriedades
Esquema 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"]
Esquema JSON
searchstring