For AI agents: the docs index is at https://apidocs.aikido.dev/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home API Reference

v1.0

API Reference

v1.0

Documentation

Authorization
Webhooks
- Verifying incoming webhooks
Rate Limiting

Authorization

Get access tokenpost

Issues

Export all issuesget
List open issue groupsget
Get issue group detailget
Get issue detailget
Get issue details bulkget
Adjust severity of an issuepost
Adjust severity of an issue grouppost
Snooze an issueput
Ignore an issueput
Solve an issueput
Get issue countsget
Get issue reachabilityget
Ignore an issue groupput
Snooze an issue groupput
Unsnooze an issueput
Unignore an issueput
Unignore an issue groupput
Unsnooze an issue groupput
Add note to issue grouppost
List notes for issue groupget
Get issue CVE exploitabilityget
Get issue CVE exploitability bulkget

Clouds

List connected cloudsget
Get cloud assetsget
Remove clouddel
Connect AWS cloudpost
Connect Azure cloudpost
Update Azure cloudput
Connect GCP cloudpost
Create Kubernetes cloudpost

Code repositories

List code repositoriesget
Export SBOMget
Export SBOM For Teamget
Get code repository detailget
Scan code repopost
Trigger repositories syncpost
Activate code repopost
Deactivate code repopost
Clone code repopost
Manage private registrypost
Set environment variablespost
Manage dev dep scanningput
Update sensitivityput
Update connectivityput
Add an exclude path to a code repopost
Remove an exclude path from a code repopost
Add code repo labelpost
Update code repo labelpost
Remove code repo labeldel
Delete code repodel

Pull & Merge requests

List PR Checksget
Get PR Check detailget
List PR Check Manual Actionsget
List PR Checks configurationsget
Configure default PR Checkspost
Get default PR Checks configurationget
Configure PR Checks for all repospost
Configure PR Checkspost

Teams

List teamsget
Update teamput
Link resource to teampost
Unlink resource from teampost
Add user to teampost
Remove user from teampost
Create teampost
Delete teamdel
Update repository path limitation for a teampost
Create parent teampost
Update child teams for parent teampost

Containers

List containersget
Get containerget
Export SBOMget
Generate bulk SBOMpost
Upload container SBOMpost
Delete containerdel
Activate containerpost
Deactivate containerpost
Update container tag filterpost
Get container registryget
Add public containerpost
Clone containerpost
Update sensitivityput
Update connectivityput
Scan containerpost
Link code repository to containerpost
Unlink code repository from containerpost
Add Azure container registrypost
Add GCP Artifact Registrypost
Add GitLab Self-Managed container registrypost
List container runnersget
Export Raw SBOMget
Add container labelpost
Update container labelpost
Remove container labeldel

Autofix

List autofix historyget
List issues addressed by a taskget
Get dependency AutoFix PR creation settingsget
Update dependency AutoFix PR creation settingsput
Get Pentest AutoFix PR creation settingsget
Update Pentest AutoFix PR creation settingsput
Get SAST & IaC AutoFix PR creation settingsget
Update SAST & IaC AutoFix PR creation settingsput
Get container AutoFix PR creation settingsget
Update container AutoFix PR creation settingsput
List Aikido imagesget
Request a hardened imagepost
List hardened image requestsget

Domains & APIs

Create domainpost
Remove domaindel
Start scan for a domainpost
List domainsget
Update OpenAPI specput
Update Auth Headerspost
List Subdomainsget
Add Subdomainpost
Remove Subdomaindel
Update Custom Scan Headerspost
List Data Leaksget
Update scan frequencypost

Reports

Export PDF reportget
List activity logget
List SAST rulesget
List IaC rulesget
List Mobile rulesget
List cloud rulesget

Zen

Create apppost
Update appput
List appsget
Get appget
Get eventget
List usersget
Update userput
Rotate app tokenpost
Get countriesget
Update countriesput
Get threat listsget
Update threat listsput
Get bot listsget
Update bot listsput
Update IP blocklistput
Update blocking modeput
Delete appdel

Users

List usersget
Get userget
Update user rightsput
Disable userput
List IDE adoptionget
List user login historyget
List pending invitesget

Compliance

SOC2 complianceget
NIS2 complianceget
ISO 27001 complianceget
GDPR complianceget
CIS complianceget
CIS AWS complianceget
DORA complianceget
PCI complianceget
FedRAMP DAST report (OSCAL)get

Virtual machines

List virtual machinesget
Export SBOMget

Custom SAST rules

List custom rulesget
Get a custom ruleget
Create custom rulepost
Edit custom ruleput
Remove custom ruledel

Pentesting & AI code analysis

List pentest assessmentsget
List AI Code Analysis assessmentsget
Get pentest assessmentget
Create pentest draftpost
Get attack analysisget

Task tracking

List task tracking integrationsget
List task tracking projectsget
List tasks from projectget
Link existing task to issuepost
Unlink a task from issuepost
Get issue group tasksget
Get project mappingget
Map code repo to task tracking projectspost
Map teams to task tracking projectspost

Local scanning

Get latest local scanner versionget

Licenses & SBOM

List & Search SBOMget
Overwrite Licensepost
Mark License As Internalpost

Research

List CWE descriptionsget
Get CVE detailsget
Get package health scoresget
Get changelog summaryget
Get malware packagesget
List end-of-life runtimesget

Scanning access tokens

Update Code Scanning Access Tokenpost

Endpoint Protection

List endpoint devicesget
List installed packagesget
List endpoint activity logsget
List endpoint exceptionsget
List endpoint permission groupsget
Add an endpoint exceptionpost
Remove an endpoint devicedel
Remove an endpoint exceptiondel

Code quality

List code quality findings for a pull requestget
List code quality findings for a repositoryget
Ignore a code quality findingput

Code coverage

List all code coverage repositoriesget
Get code coverage for a repositoryget

Request inbox

List user requestsget
Review a user requestpost

Webhooks

List webhooksget
Add webhookpost
Remove webhookdel

Bug bounty

Validate Bug Bounty Reportpost

Workspace

Get workspace infoget
Get workspace configuration errorsget
Get OpenAPI specget
Get SLA settingsget
Get wallet balanceget

Broker

List broker appsget
Add a broker resource URLpost
Delete a broker resource URLdel

Powered by

Get user

get

https://app.aikido.dev/api/public/v1/users/{user_id}

Returns the specified user details

Path Params

user_id

int32

required

0 to 1

The ID of the user

Response

Updated 5 months ago

Update user rights

Did this page help you?

Language

URL

Loading…

Response

Choose an example:

application/json

Updated 5 months ago

Update user rights

Did this page help you?