FutureVuls API#
FutureVuls provides a REST API for developing external applications. You can use the API to retrieve data from FutureVuls.
Refer to the "API Documentation" for details on the API. You can check the API parameters and response types.
To access the FutureVuls API, specify an API token in the Authorization header. API tokens can be viewed, created, edited, deleted, regenerated, and enabled/disabled on the settings screen for Groups, Group Sets, and Organizations. API tokens can also be assigned different permission levels.
Note on Using the API Documentation
Please be aware that the feature on the "FutureVuls API Documentation" page that allows you to try out APIs directly from the browser is currently not working.

FutureVuls API Token Management#
FutureVuls API tokens are managed on the "Token" page within the Group, Group Set, and Organization settings.

Here, you can manage tokens for Scanners and the FutureVuls API. Only users with the following permissions can access this screen (Reference: User Permissions):
| Token Type | Required Permission |
|---|---|
| Group | Group Admin |
| Group Set | Groupset Admin |
| Organization | Organization Permission (Owner, CSIRT) |
Creating a FutureVuls API Token#
You can add an API token by clicking Add a new token.
Create the token by setting its name and permissions.

The permissions that can be set are as follows:
| Token Type | API Permission | Scan Permission |
|---|---|---|
| Group Token | ・Read, Update, Group Settings ・Read, Update ・Read Only ・None |
Yes/No |
| Group Set Token | ・Read, Update ・Read Only |
ー |
| Organization Token | ・Read, Update, Organization Settings ・Read, Update ・Read Only |
ー |
Updating a Token#
Created tokens can be edited, regenerated, deleted, and enabled/disabled from the list.
| Action | Description |
|---|---|
| Edit | You can edit the API token name, API Permission, and Scan Permission. |
| Regenerate | You can regenerate the API token hash. This action cannot be undone, so please proceed with caution. |
| Delete | Deletes the API token. Using a deleted token will result in an authentication failure. |
| Enable/Disable | You can toggle the token's status using the toggle switch in the status column. Using a disabled token will result in an authentication failure. |
How to Use the FutureVuls API#
Make an HTTP request to https://rest.vuls.biz using a URL path from the API Method List.
For APIs that return multiple items in the response, such as the task list API, the data is sorted in ascending order by ID. In the FutureVuls API Documentation, you can check the request/response data models for each API by clicking on "Model".

Example: To retrieve all vulnerability information for Server ID=1#
Please also refer to the "API Samples" page for specific examples of how to use the API.
curl -s -H 'accept: application/json' -H 'Authorization:xxxxxxxxxxxxx' 'https://rest.vuls.biz/v1/cves?filterServerID=1&page=1&limit=20' | jq
/cve/{cve ID}is a Group API, so specify the group's token in the header.- To filter results for a specific server, specify
filterServerIDin the format?filterServerID=1. - To limit the number of items retrieved per request, specify
pageandlimit.
For detailed endpoint specifications, please check the relevant section of the documentation.
Notes on Using the FutureVuls API#
- For large datasets like software lists or task lists, using filters can speed up retrieval.
- Some APIs have default parameter values. Please check the documentation (FutureVuls API) for these default values.
- For parameters that accept an array, join multiple instances of the same key with
&(e.g.,filterStatus=new&filterStatus=investigating).
How to Specify Array Parameters#
When specifying multiple array-type parameters in the API, you need to specify the same key multiple times, joined with &.
Example 1: Specifying multiple statuses when retrieving a task list
https://rest.vuls.biz/v1/tasks?filterStatus=new&filterStatus=investigating&filterStatus=ongoing
Example 2: Specifying multiple task IDs and comment types when batch retrieving task comments
https://rest.vuls.biz/v1/taskComments?taskIDs=1&taskIDs=2&taskIDs=3&commentTypes=user&commentTypes=api
Example 3: Specifying multiple CVE IDs when retrieving group set vulnerability information
https://rest.vuls.biz/v1/groupSet/cveVulnInfos?cveIDs=CVE-2023-1234&cveIDs=CVE-2023-5678
For more details, please also refer to "API Samples".
Pagination#
The FutureVuls API uses pagination to support large amounts of data. The maximum number of list items that can be retrieved at once (limit) is 1000, and you can retrieve all items by incrementing the page number (page). (Reference: Optional Parameters)
When you need to retrieve all items, please set the pagination parameters appropriately.
- If the
limitvalue is not specified, a default value oflimit=20is set, and a maximum of 20 items will be retrieved. - By reducing the
limitvalue, you can shorten the execution time of a single API call (and increase the number of requests usingpage). - Setting
limithigher than the total number of items is fine (only items up to the total count will be retrieved).
Example 1) You want to retrieve all 80 items (<1000) in a list.
- Execute with
?limit=1000or similar.
Example 2) You want to retrieve all 1500 items (>1000) in a list.
- First, execute with
?page=1&limit=1000. - Next, execute with
?page=2&limit=1000.
Counting the Total (totalCount)#
List API responses include the total number of items that match the conditions (totalCount) and the total number of pages (totalPage).
By default, the latest total count is calculated for every request.
When you retrieve large amounts of data page by page, you can speed up responses by changing how the total count is calculated with the following parameters.
| Parameter | Default Value | Description | Available APIs |
|---|---|---|---|
exactCount |
true |
If false, stops counting the total at 100,000 |
Task list, software list, and deleted software list |
allowCachedCount |
false |
If true, uses a total count calculated up to 30 minutes earlier for the second and subsequent pages, except the last page. The first and last pages use the latest count |
CVE list, task list, software list, and deleted software list |
The total count returned for each combination is as follows.
Because the CVE list APIs do not have exactCount, they behave the same as the rows where exactCount is true.
exactCount |
allowCachedCount |
Returned Total Count | Recommended Use |
|---|---|---|---|
true (default) |
false (default) |
The latest count, calculated every time | When you always need the latest total count |
true (default) |
true |
First and last pages: the latest count, calculated every time Second and subsequent pages (excluding the last page): a count calculated up to 30 minutes earlier |
When you want to page through large amounts of data quickly |
false |
(Ignored if specified) | A count calculated every time, but capped at 100,000 | When a rough total count is enough and you do not retrieve all data |
- The "first page" is a request with
page=1andoffset=0. The "second and subsequent pages" are requests with apageof 2 or more, or anoffsetof 1 or more. - If
allowCachedCount=true, the second and subsequent pages use the total count most recently calculated for the same group (or group set) and the same filter conditions. However, the latest count is recalculated on the last page, so you can decide whether to stop paging based on the latest count. - Even if
allowCachedCount=true, the retrieved data (the list contents) is always the latest. OnlytotalCountandtotalPageuse earlier values. - If you specify
exactCount=falseand the total count exceeds 100,000,totalCountis 100,000 andtotalCountCappedin the response istrue. To retrieve all data, keepexactCountattrue.
The default value of allowCachedCount will change to true in the December 2026 release
After the change, totalCount and totalPage for the second and subsequent pages (excluding the last page) may be values from up to 30 minutes earlier, even if you do not specify the parameter. If you use the total count from these pages as the latest count, explicitly specify allowCachedCount=false.
Software and Task Update Timestamps#
Scans or SBOM re-uploads that do not change the contents of software or tasks do not update their updatedAt timestamps.
During scans, software cpeAssignedAt is updated only when the assigned CPE vendor or product changes, not when only the version changes.
Task Count Fields Removed from Role Endpoints#
The October 2026 release removed newTaskCount and allTaskCount from GET /v1/roles and GET /v1/role/{roleID}.
Instead, specify the role with filterRoleID on GET /v1/tasks and use totalCount.
- Instead of
newTaskCount: specifynewforfilterStatusandtrueforfilterIgnore - Instead of
allTaskCount: specify all statuses forfilterStatus(the default includes onlynew,investigating, andongoing)
Queuing for Scans and SBOM Registration#
If you call the following APIs in quick succession, the requests may be queued per organization, which can slow down responses.
POST /v1/server/scan/{serverID}(server scan)POST /v1/server/pasteandPUT /v1/server/paste/{serverID}(adding and updating paste servers)POST /v1/server/sbom(SBOM import)PUT /v1/sbom/{sbomID}(SBOM update with an SBOM file)
While a request is queued, the API does not return an error; it holds the response until the request is processed. Even if the call times out on the client side during this time, processing continues. Resending the same request duplicates the processing, so do not resend it.
Differential Sync API (v2)#
If you replicate tasks and software to an external system and keep them in sync periodically, you can use the differential sync API (v2) to efficiently retrieve only the data that has changed since your last retrieval. Note that some data, such as deleted tasks, is not returned as a difference, so to keep the replica consistent you must also periodically retrieve all data and reconcile it (see the notes below for details).
| Target | Group API | Group Set API |
|---|---|---|
| Tasks | GET /v2/tasksGET /v2/tasks/count |
GET /v2/groupSetTasksGET /v2/groupSetTasks/count |
| Software | GET /v2/softwaresGET /v2/softwares/count |
GET /v2/groupSetSoftwaresGET /v2/groupSetSoftwares/count |
The list endpoints accept the following parameters.
| Parameter | Description |
|---|---|
cursor |
Specify the nextCursor from the previous response as is. Do not specify it on the first request |
limit |
The number of items to retrieve per request (1 to 1000, default 100) |
filterUpdatedAtAfter |
The time to start reading from on the first request (when cursor is not specified), as a UTC time in RFC3339 format. Ignored when cursor is specified |
filterStatus |
Filters by task status (tasks only) |
The response consists of items (in ascending order of last updated time), nextCursor, and hasMore. Synchronize as follows.
- Call the list endpoint without specifying
cursor - Save the
nextCursorfrom the response and specify it as thecursorof the next request. Repeat untilhasMoreisfalse - After that, call the endpoint periodically with the saved
nextCursorto retrieve changes (nextCursoris returned even whenitemsis empty)
Notes on the differential sync API
- The same data may be returned more than once. On the receiving side, register or update (upsert) data using
idas the key - Deleted software is returned with
deletedAt. Treat data withdeletedAtset as deleted on the receiving side as well. However, software deleted through some paths, such as deleting a manually registered CPE, deleted tasks, and tasks that no longer match thefilterStatuscondition are not returned, so periodically retrieve all data again and reconcile - If the group set configuration or the filter conditions change,
409(sync_reset_required) is returned. Discard the savedcursorand retrieve everything again from the beginning - The result of the count endpoints (
/count) may be up to 30 minutes out of date. Ifcappedin the response istrue, the count means "at least this value"
API Method List#
APIs are divided into three types based on their token type. Each type provides different methods, so please check the manual for details.
API Server Health Check#
| HTTP Method | URL | Description | Required Permission |
|---|---|---|---|
| GET | /health | health | None |
Group API List#
To use the Group API, you must use a group-specific API token issued for each group.
Token Type
Tokens issued in Organization settings and Group Set settings cannot be used with the Group API.
| HTTP Method | URL | Description | Required Permission | Remarks |
|---|---|---|---|---|
| GET | /v1/cve/{cveID} | CVE Detail | Read | How to get cveID |
| GET | /v1/cves | CVE List | Read | With Options |
| GET | /v1/lockfiles | Lockfile List | Read | With Options |
| GET | /v1/lockfile/{lockfileID} | Lockfile Detail | Read | How to get lockfileID |
| POST | /v1/lockfile | Add Lockfile | Update | Add Lockfile |
| PUT | /v1/lockfile/{lockfileID} | Update Lockfile | Update | How to get lockfileID |
| DELETE | /v1/lockfile/{lockfileID} | Delete Lockfile | Update | How to get lockfileID |
| POST | /v1/pkgCpe/cpe | Add CPE | Update | |
| DELETE | /v1/pkgCpe/cpe/{cpeID} | Delete CPE | Update | How to get cpeID Only manually registered CPEs (software type Private Package) can be deleted |
| DELETE | /v1/pkgCpe/cpe | [DEPRECATED] Delete CPE | Update | How to get cpeID Only manually registered CPEs (software type Private Package) can be deleted |
| GET | /v1/pkgCpe/cpe/{cpeID} | CPE Detail | Read | How to get cpeID |
| GET | /v1/pkgCpe/pkg/{pkgID} | Package Detail | Read | How to get pkgID |
| GET | /v1/pkgCpe/windowsPkg/{windowsPkgID} | WindowsPkg Detail | Read | How to get windowsPkgID |
| GET | /v1/pkgCpes | Package & CPE List | Read | With Options |
| GET | /v1/deletedPkgCpes | Deleted Software List | Read | With Options |
| GET | /v1/supplyChainRisks | Supply Chain Risk List | Read | |
| GET | /v1/role/{roleID} | Role Detail | Read | How to get roleID |
| PUT | /v1/role/{roleID} | Update Role | Update | How to get roleID |
| DELETE | /v1/role/{roleID} | Delete Role | Update | How to get roleID |
| GET | /v1/roles | Role List | Read | With Options |
| POST | /v1/server/pseudo | Create Pseudo Server | Update | |
| POST | /v1/server/paste | Create Paste Server | Update | |
| POST | /v1/server/sbom | Import SBOM | Update | Specify ignoreOS=true to ignore OS information (details) |
| GET | /v1/server/{serverID}/sbom | Download Server's SBOM | Read | How to get serverID API Usage Example Specify excludeVulnerabilities=true to output without vulnerability information (details) |
| PUT | /v1/server/paste/{serverID} | Update Paste Server | Update | How to get serverID |
| GET | /v1/server/uuid/{serverUuid} | Server Detail by UUID | Read | How to get UUID |
| POST | /v1/server/scan/{serverID} | Scan Server | Update | How to get serverID |
| GET | /v1/server/{serverID} | Server Detail | Read | How to get serverID |
| PUT | /v1/server/{serverID} | Update Server | Update | How to get serverID |
| DELETE | /v1/server/{serverID} | Delete Server | Update | How to get serverID |
| POST | /v1/server/{serverID}/tag | Add Server Tag | Update | How to get serverID |
| DELETE | /v1/server/{serverID}/tag | Delete Server Tag | Update | How to get serverID |
| GET | /v1/servers | Server List | Read | With Options |
| POST | /v1/servers/{serverUuid}/reachability | Upload Reachability Analysis Results | Update | Setting Up Reachability Analysis |
| GET | /v1/task/{taskID} | Task Detail | Read | How to get taskID |
| PUT | /v1/task/{taskID} | Update Task | Update | How to get taskID |
| PUT | /v1/tasks | Bulk Update Tasks | Update | Bulk update status/priority for up to 1,000 task IDs |
| POST | /v1/task/{taskID}/comment | Add Task Comment | Update | How to get taskID |
| GET | /v1/taskComments | Batch Get Task Comments | Read | With Options How to specify multiple Task IDs or comment types |
| PUT | /v1/task/{taskID}/ignore | Set Task to Ignore | Update | How to get taskID |
| GET | /v1/tasks | Task List | Read | With Options |
| GET | /v1/members | Member List | Read | With Options |
| GET | /v1/scanImports | External Scan Result List | Read | With Options |
| GET | /v1/scanImport/{scanImportID} | External Scan Detail | Read | How to get scanImportID |
| POST | /v1/scanImport | Add External Scan Result | Update | |
| PUT | /v1/scanImport/{scanImportID} | Update External Scan Result | Update | |
| DELETE | /v1/scanImport/{scanImportID} | Delete External Scan Result | Update | |
| GET | /v1/sbom/{sbomID} | Get SBOM Detail | Read | |
| GET | /v1/sboms | Get SBOM List | Read | |
| POST | /v1/sbom | Add SBOM | Update | Specify ignoreOS=true to ignore OS information (details) |
| PUT | /v1/sbom/{sbomID} | Update SBOM | Update | Specify ignoreOS=true to ignore OS information (details) |
| DELETE | /v1/sbom/{sbomID} | Delete SBOM | Update | |
| GET | /v2/tasks | Task Differential Sync List | Read | Differential Sync API (v2) |
| GET | /v2/tasks/count | Task Count | Read | Differential Sync API (v2) |
| GET | /v2/softwares | Software Differential Sync List | Read | Differential Sync API (v2) |
| GET | /v2/softwares/count | Software Count | Read | Differential Sync API (v2) |
Group Set API List#
To use the Group Set API, you must use a group set-specific API token issued for each group set.
Token Type
Tokens issued in Organization settings and Group settings cannot be used with the Group Set API.
| HTTP Method | URL | Description | Required Permission | Remarks |
|---|---|---|---|---|
| GET | /v1/groupSet/cve/{cveID} | CVE Detail | Read | How to get cveID |
| GET | /v1/groupSet/cves | CVE List | Read | With Options |
| GET | /v1/groupSet/cveVulnInfos | List of CVE Vulnerability Information | Read | With Options How to specify multiple CVE IDs |
| GET | /v1/groupSet/pkgCpe/cpe/{cpeID} | CPE Detail | Read | How to get cpeID |
| GET | /v1/groupSet/pkgCpe/pkg/{pkgID} | Package Detail | Read | How to get pkgID |
| GET | /v1/groupSet/pkgCpe/windowsPkg/{windowsPkgID} | WindowsPkg Detail | Read | How to get windowsPkgID |
| GET | /v1/groupSet/pkgCpes | Package & CPE List | Read | With Options |
| GET | /v1/groupSet/deletedPkgCpes | Deleted Software List | Read | With Options API Sample |
| GET | /v1/groupSet/supplyChainRisks | Supply Chain Risk List | Read | |
| GET | /v1/groupSet/server/uuid/{serverUuid} | Server Detail by UUID | Read | How to get UUID |
| GET | /v1/groupSet/server/{serverID} | Server Detail | Read | How to get serverID |
| GET | /v1/groupSet/servers | Server List | Read | With Options |
| GET | /v1/groupSet/task/{taskID} | Task Detail | Read | How to get taskID |
| GET | /v1/groupSet/tasks | Task List | Read | With Options |
| GET | /v2/groupSetTasks | Task Differential Sync List | Read | Differential Sync API (v2) |
| GET | /v2/groupSetTasks/count | Task Count | Read | Differential Sync API (v2) |
| GET | /v2/groupSetSoftwares | Software Differential Sync List | Read | Differential Sync API (v2) |
| GET | /v2/groupSetSoftwares/count | Software Count | Read | Differential Sync API (v2) |
Organization API List#
To use the Organization API, you must use an organization-specific API token issued in the organization settings.
Token Type
Tokens issued in Group Set settings and Group settings cannot be used with the Organization API.
Note on Token Management
The Organization token can be used to retrieve the "Group List, Group Set List, Member List" within the organization. The API response includes "personal information such as members' names and email addresses." Please manage the token with extreme care.
Also, future releases are expected to add organization-wide settings, including those listed below. Please be careful with the handling of the organization token.
- Actions available from organization settings (e.g., adding external users).
- The ability to call APIs across all group sets and groups in the organization.
| HTTP Method | URL | Description | Required Permission | Remarks |
|---|---|---|---|---|
| GET | /v1/org/groups | Group List | Read | |
| GET | /v1/org/groupsets | Group Set List | Read | |
| GET | /v1/org/members | Member List | Read | |
| GET | /v1/org/auditLogs | Audit Log List | Read | |
| POST | /v1/org/group | Create Group | Organization Settings | |
| PUT | /v1/org/group/{groupID} | Update Group Settings | Organization Settings | |
| POST | /v1/org/users | Add User to Group/Group Set | Organization Settings | |
| GET | /v1/org/privateEndoflifeDates | Private EOL Information List | Read | API Sample |
| POST | /v1/org/privateEndoflifeDate | Register Private EOL Information | Organization Settings | API Sample |
| PUT | /v1/org/privateEndoflifeDate/{privateEndoflifeDateID} | Update Private EOL Information | Organization Settings | API Sample |
| DELETE | /v1/org/privateEndoflifeDate/{privateEndoflifeDateID} | Delete Private EOL Information | Organization Settings | API Sample |
How to Get Parameters for API Calls#
When using the FutureVuls API, you may need to specify parameters such as cveID or cpeID.
This section explains how to obtain these parameters.
How to get cveID#
You can obtain it in one of the following two ways:
- Open the Vulnerabilities tab and refer to the
CVE IDcolumn for the desired vulnerability. - Retrieve it via a REST API request.
- For the Group API:
- Execute a GET request to
https://rest.vuls.biz/v1/cvesto get the vulnerability list. In the response JSON, refer to thecveIDof the desired vulnerability within thecvesdata.
- Execute a GET request to
- For the Group Set API:
- Execute a GET request to
https://rest.vuls.biz/v1/groupSet/cvesto get the vulnerability list. In the response JSON, refer to thecveIDof the desired vulnerability within thecvesdata.
- Execute a GET request to
- For the Group API:

How to get cpeID#
You can obtain it using the following method:
- When using the Group API:
- Execute a GET request to
https://rest.vuls.biz/v1/pkgCpesto get the package & cpe list. In the response JSON, refer to thecpeIDof the desired CPE within thepkgCpesdata.
- Execute a GET request to
- When using the Group Set API:
- Execute a GET request to
https://rest.vuls.biz/v1/groupSet/pkgCpesto get the package & cpe list. In the response JSON, refer to thecpeIDof the desired CPE within thepkgCpesdata.
- Execute a GET request to
How to get pkgID#
You can obtain it using the following method:
- When using the Group API:
- Execute a GET request to
https://rest.vuls.biz/v1/pkgCpesto get the package & cpe list. In the response JSON, refer to thepkgIDof the desired package within thepkgCpesdata.
- Execute a GET request to
- When using the Group Set API:
- Execute a GET request to
https://rest.vuls.biz/v1/groupSet/pkgCpesto get the package & cpe list. In the response JSON, refer to thepkgIDof the desired package within thepkgCpesdata.
- Execute a GET request to
How to get UUID#
You can obtain it in one of the following two ways:
- Open the Servers tab and refer to the
Server UUIDcolumn for the desired server. (TheServer UUIDcolumn can be displayed from "Edit displayed items"). - Retrieve it via a REST API request.
- For the Group API:
- Execute a GET request to
https://rest.vuls.biz/v1/serversto get the server list. In the response JSON, refer to theserverUuidof the desired server within theserversdata.
- Execute a GET request to
- For the Group Set API:
- Execute a GET request to
https://rest.vuls.biz/v1/groupSet/serversto get the server list. In the response JSON, refer to theserverUuidof the desired server within theserversdata.
- Execute a GET request to
- For the Group API:
How to get serverID#
You can obtain it in one of the following two ways:
- Open the Servers tab and refer to the
Server IDcolumn for the desired server. (TheServer IDcolumn can be displayed from "Edit displayed items"). - Retrieve it via a REST API request.
- For the Group API:
- Execute a GET request to
https://rest.vuls.biz/v1/serversto get the server list. In the response JSON, refer to theidof the desired server within theserversdata.
- Execute a GET request to
- For the Group Set API:
- Execute a GET request to
https://rest.vuls.biz/v1/groupSet/serversto get the server list. In the response JSON, refer to theidof the desired server within theserversdata.
- Execute a GET request to
- For the Group API:
How to get taskID#
You can obtain it in one of the following two ways:
- Open the Tasks tab and refer to the
Task IDcolumn for the desired task. (TheTask IDcolumn can be displayed from "Edit displayed items"). - Retrieve it via a REST API request.
- For the Group API:
- Execute a GET request to
https://rest.vuls.biz/v1/tasksto get the task list. In the response JSON, refer to theidof the desired task within thetasksdata.
- Execute a GET request to
- For the Group Set API:
- Execute a GET request to
https://rest.vuls.biz/v1/groupSet/tasksto get the task list. In the response JSON, refer to theidof the desired task within thetasksdata.
- Execute a GET request to
- For the Group API:
How to get roleID#
You can obtain it using the following method:
- Open the Roles tab and refer to the
Role IDcolumn for the desired role. (TheRole IDcolumn can be displayed from "Edit displayed items"). - Retrieve it via a REST API request.
- Execute a GET request to
https://rest.vuls.biz/v1/rolesto get the role list. In the response JSON, refer to theidof the desired role within therolesdata.
- Execute a GET request to
How to get lockfileID#
You can obtain it using the following method:
- Open the Servers tab and select the server where the desired Lockfile exists. From the Applications tab, select the desired Lockfile and refer to the value after the
#.
- Retrieve it via a REST API request.
- Execute a GET request to
https://rest.vuls.biz/v1/lockfilesto get the Lockfile list. In the response JSON, refer to theidof the desired Lockfile within thelockfilesdata.
- Execute a GET request to
How to get windowsPkgID#
You can obtain it using the following method:
- Open the Servers tab and select the server where the desired package exists. Open the Software tab and refer to the
IDcolumn. - Open the Servers tab and select the server where the desired package exists. From the Software tab, select the desired package and refer to the value after the
#in the displayed windowsPkg.

How to get scanImportID#
You can obtain it using the following method:
- Retrieve it via a REST API request
- Execute a GET request to
https://rest.vuls.biz/v1/scanImportsto get the scan result list. In the response JSON, refer to theidof the desired scan result within thescanImportsdata.
- Execute a GET request to
Optional Parameters#
Depending on the API, the following options can be specified when retrieving data. Please refer to the FutureVuls API Documentation for the options available for each API.
When specifying array parameters
If you are specifying an array parameter, you need to specify it multiple times.
For example, if you want to filter tasks with a status of either "new" or "investigating" using the task list retrieval API, you must execute it with a URL like this:
"https://rest.vuls.biz/v1/tasks?filterStatus=new&filterStatus=investigating"
| Parameter | Type | Default Value | Description |
|---|---|---|---|
| page | integer | 1 | The page number to retrieve from paginated data. |
| limit | integer | 20 | The number of items per page for paginated data. |
| offset | integer | 0 | The number of items to skip before starting pagination. |
| filterCveID | string | ー | Retrieves only data related to the specified cveID. |
| filterTaskID | integer | ー | Retrieves only data related to the specified taskID. |
| filterServerID | integer | ー | Retrieves only data related to the specified serverID. |
| filterRoleID | integer | ー | Retrieves only data related to the specified roleID. |
| filterPkgID | integer | ー | Retrieves only data related to the specified pkgID. |
| filterCpeID | integer | ー | Retrieves only data related to the specified cpeID. |
| filterStatus | array[string] | ["new", "investigating", "ongoing"] | Retrieves only tasks with the specified statuses. |
| filterPriority | array[string] | ー | Retrieves only tasks with the specified priorities. |
| filterIgnore | boolean | ー | true: Retrieves only tasks with the ignore flag OFF. false: Retrieves all items. |
| filterMainUserIDs | array[integer] | ー | Retrieves only tasks where the specified user ID is the primary assignee. |
| filterSubUserIDs | array[integer] | ー | Retrieves only tasks where the specified user ID is a secondary assignee. |
| filterIsExternalScan | boolean | ー | Retrieves only tasks and vulnerabilities where external scan is enabled. |
| filterReachability | array[string] | ー | Retrieves only tasks in the specified reachability states (reachable, partial, not_reachable)Only for the v1 task list ( /v1/tasks, /v1/groupSet/tasks) |
| filterReachabilityIsUnanalyzed | boolean | ー | true: Retrieves only tasks without a reachability value false: Retrieves only tasks with a reachability value Only for the v1 task list ( /v1/tasks, /v1/groupSet/tasks) |
| filterSbomUuid | string | ー | Retrieves only lockfiles registered from the SBOM with the specified UUID (lockfile list). |
For example, consider retrieving a list of servers registered in a group.
A GET request to https://rest.vuls.biz/v1/servers?page=1&limit=20&offset=5 will retrieve 20 items, excluding the first 5, in serverID order. That is, data from the 6th to the 25th item will be retrieved.
If you use https://rest.vuls.biz/v1/servers?page=2&limit=20&offset=5, data from the 26th to the 45th item will be retrieved.
If you do not specify an offset, https://rest.vuls.biz/v1/servers?page=1&limit=20 will retrieve data from the 1st to the 20th item.
Also, executing a GET request to https://rest.vuls.biz/v1/tasks?filterPriority=high&filterPriority=medium will retrieve a list of tasks with a priority of HIGH or MEDIUM.