NeXpose API¶
NeXpose APIs provide programming access to commonly used functions . You can also use the API to automate internal auditing and security activities, and integrate your environment with third-party products. There are currently two categories of APIs.
NeXpose API 1.1¶
The NeXpose API 1.1 is available in NeXpose 4.0 or later and is broken down into the followingfunctional categories:
- Session management
- Site management
- Device management
- Asset group management
- Vulnerability assessment
- Reporting
The requests made to the NeXpose API 1.1 are validated with DTDs documented in NeXpose_API_v1.1_Guide.
Examples of requests and responses can be found here: XML API 1.1 Examples
NeXpose Extended API 1.2¶
The NeXpose Extended API 1.2 provides extended functionality available in NeXpose 4.8 or later.It is broken down into the following functional categories:
- Scan Engine management
NOTE: API 1.1 Session Management is required for Scan Engine management.
The requests made to the NeXpose API 1.2 is documented in this guide and can be validated with the XML schemas provided in the package NeXpose_Extended_API_XMLSchemas_v1.2.zip.
More information about NeXpose Extended API 1.2 is available in NeXpose_Extended_API_v1.2_Guide.
Accessing the APIs¶
Access NeXpose API v1.1 by sending requests to /api/1.1/xml.
Access NeXpose Extended v1.2 by sending requests to /api/1.2/xml.