Jump to Content
Docs
Recipes
API Reference
Changelog
Home
GitHub
Sign Up
API Reference
Home
GitHub
Sign Up
Moon (Dark Mode)
Sun (Light Mode)
Docs
Recipes
API Reference
Changelog
/login
Search
JUMP TO
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
AttackChains
Retrieves a list of attack chains that match the provided filters.
post
AccessKeys
/authentication/accessKeys
get
/authentication/accessKeys
put
/authentication/accessKeys
post
/authentication/accessKeys/{guid}
get
/authentication/accessKeys/{guid}
delete
Collaboration
/collaboration/config
delete
/collaboration/config
put
/collaboration/config
post
Get collaboration configuration options
get
Get collaboration configuration options
post
Get collaboration configuration templates
get
Share data
post
CustomerState
Get customer's "getting started" checklist state
get
Get customer's onboarding state
get
/customerState/reports/imageScan
get
/customerState/reports/postureScan
get
/customerState/reports/registryScan
get
/customerState/reports/repositoryPostureScan
get
Update customer's "getting started" checklist state
put
Update customer's onboarding state
put
Features
/features
get
/integrations/jira/configV2
get
get
JiraIntegration
/integrations/jira/configV2
post
Get a filtered Jira field values list.
post
Get Jira fields schemas list for an issue type.
post
Get Jira issue types list.
post
Create a Jira issue (ticket).
post
/integrations/jira/projectsV2/search
post
Integrations
Get integrations connection status.
delete
Login
/login
post
Logout
delete
Redirect to oauth2 login page
get
Returns URL to for login with callback
get
Returns URL to for login
get
Get the list of customers this user allowed to.
get
Get various information on this user + customer.
get
/openid_customers
post
NetworkPolicy
Retrieve all network policies for a customer.
post
Generate network policies for specific workloads.
post
AlertChannel
Create new alert channel
delete
Posture
Get clusters list with history
post
Returns list of posture controls run results
post
Get framework sections
post
Get scan summary per framework
post
Returns list of resources which reported by posture report as affected resource
post
Returns list of resources which reported by posture report as affected resource
post
Get values for inner filter of /posture/frameworks POST requests
post
Get values for inner filter of /posture/resources POST requests
post
Exception
/postureExceptionPolicy
get
/postureExceptionPolicy
put
/postureExceptionPolicy
post
/postureExceptionPolicy
delete
/vulnerabilityExceptionPolicy
get
Update an existing exception.
put
Create vulnerability exceptions.
post
Delete vulnerability exceptions.
delete
Registry
/registry/scan
put
/registry/scan
post
/registry/scan
delete
Repository
/repositoryPosture/failedControls
post
Get file summary of repository posture report
post
Get repository summary of repository posture report
post
Get resource summary of repository posture report
post
Get values for inner filter of /repositoryPosture/files POST requests
post
Get values for inner filter of /repositoryPosture/repositories POST requests
post
/uniqueValues/repositoryPosture/resources
post
/runtime/exceptions/new
Creates a new policy exception for specified resources.
post
Runtime
Retrieve all runtime incidents for a customer.
post
Retrieve runtime alerts for a specific incident.
post
Provide a detailed explanation for a runtime incident.
get
Resolve a runtime incident.
post
Unresolve a runtime incident.
patch
Get incidents per severity.
post
RuntimePolicies
Creates a new runtime policy with the specified configuration.
post
Seccomp
Generate seccomp profiles.
post
Retrieve a list of seccomp-related resources.
post
SecurityRisks
Retrieve a list of security risks that match the provided filters.
post
Retrieve resources associated with specific security risks.
post
Retrieve a summary of security risk severities for the specified customer GUID.
post
Tenants
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 it
get
Vulnerability
Get vulnerabilities history
post
Issue a scan for a specific context / workload
post
Get detailed list of vulnerabilities
post
Get summary a scan
post
Get big numbers from the latest scan
post
Get list of the top vulnerabilities
post
Retrieving a List of Vulnerabilities in Components scope
post
Retrieving a List of Vulnerability Images scope
post
Retrieving a List of Vulnerabilities
post
Retrieving a List of vulnerabilities in Workloads scope
post
Powered by
/login
post
https://api.armosec.io/api/v1/login
Get session cookie for specific user + customer
Language
Shell
Node
Ruby
PHP
Python
Credentials
Query
URL
Base URL
https://api.armosec.io/api/v1
/login
RESPONSE
Click
Try It!
to start a request and see the response here!
