Jump to Content

Docs Recipes API Reference Changelog

Home GitHub Sign Up

API Reference

Home GitHub Sign Up

Docs Recipes API Reference Changelog

Login APIs

/api/v1/createTenant
/openid_customers

Live data APIs

Image scan APIs
- topVulnerabilities
Posture report APIs
- topControls

Configurations Scan API

Posture exception policy
- GET /api/v1/postureExceptionPolicy
- Mutation APIs

Vulnerability Scan API

Vulnerability Exception policy

Common API structures

Pagination APIs structure

ARMO Platform API

Customer API
/api/v1/customerState/connectedClusters
- Get connected clusters stateget
/api/v1/customerState/gettingStarted
- Get customer's "getting started" checklist stateget
- Update customer's "getting started" checklist stateput
/api/v1/customerState/onboarding
- Get customer's onboarding stateget
- Update customer's onboarding stateput
/api/v1/customerState/reports/imageScan
- getget
/api/v1/customerState/reports/postureScan
- getget
/api/v1/customerState/reports/registryScan
- getget
/api/v1/customerState/reports/repositoryPostureScan
- getget
Collaboration
/createTenant
- Create new tenant (customer) in ARMO portal and in ARMO identity managment and return invitation token for this new customer, so the user will be able to join itget
/features
- getget
/login
- postpost
/logout
- Logoutdelete
/oauth2/login
- Redirect to oauth2 login pageget
/open_id_callback
- Returns URL to for login with callbackget
/open_id_url
- Returns URL to for loginget
/openid_customers
- Get the list of customers this user allowed to.get
- postpost
Configuration Scanning
Registry Scanning
Repositories Scan
/v1/customerAttributes
- Get various information on this user + customer.get
Image Scanning

Powered by

/registry/scan

put https://api.armosec.io/api/v1/registry/scan

Update registry cron job

Language

Credentials

Header

URL

Click Try It! to start a request and see the response here!