REST APIs
Using REST API calls, the IQ Server provides functionality to create and update applications, as well as retrieve values for policy violations.
These APIs have been designed for system-to-system functionality; however, examples are provided using the HTTP client cURL. Following along, you can initiate the described API REST request via the command line tool.
REST APIs are versioned. This document represents the most recent version. If you plan to use any of these, we highly recommend updating to the latest version of the IQ Server to ensure compatibility.
Consider taking appropriate measures to prevent security issues such as Injection and Cross-Site Scripting (XSS) when using the responses of the APIs.
Available APIs:
- Accessing REST APIs via Reverse Proxy Authentication
- Advanced Search REST API - Early Access
- Application Categories REST API - v2
- Application REST APIs - v2
- Authorization Configuration (aka Role Membership) REST API - v2
- Component Claim REST API - v2
- Component Details REST API - v2
- Component Evaluation REST APIs - v2
- Component Labels REST API - v2
- Component Remediation REST API - v2
- Component Search REST APIs - v2
- Components in Quarantine REST API - v2
- Component Versions REST API - v2
- Component Waivers REST API - v2
- Cross-Stage Policy Violation REST API - v2
- CycloneDx REST API - v2
- Data Retention Policy REST API - v2
- HTTP Proxy Server Configuration REST API - v2
- HTTP Proxy Server Exclude Hosts Configuration REST API - v2
- Mail REST API - v2
- Organization REST APIs - v2
- Policy Violation REST API - v2
- Policy Waiver REST API - v2
- Promote Scan REST API - v2
- Release Component from Quarantine REST API - v2
- Report-related REST APIs - v2
- Role REST API - v2
- SAML REST API - v2
- Source Control REST API - v2
- Stale Waivers REST API - v2
- Success Metrics Data REST API - v2
- Third-Party Scan REST API - v2
- User REST API - v2
- User Token REST API - v2
- Using Other Supported Formats with the REST API
- Vulnerability Details REST API - v2