# Rapid7 Files API

**Canonical:** https://apis.io/apis/rapid7/rapid7-files-api/  
**Provider:** Rapid7 — https://apis.io/providers/rapid7/  
**Base URL:** https://us.api.insight.rapid7.com/vm/v4  
**Documentation:** https://help.rapid7.com/insightvm/en-us/api/api.html

Rapid7 Files API is one of 50 APIs that [Rapid7](https://apis.io/providers/rapid7/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include File. The published artifact set on APIs.io includes an OpenAPI specification.

Files are used primarily to manage content that can be required to successfully scan an App. For example, many supported methods of configuring authentication in a Scan Config require a payload and similarly Scan crawl configuration can be enhanced by supplying pre-populated crawl results. In order to create a File you will need to perform 2 steps:<ol><li>Use the <a href="#operation/create-file">Create File</a> API to provide the File's metadata and generate an <code>id</code> (can be derived from the <code>Location</code> header as described in 'Creating resources').</li><li>Use the <a href="#operation/upload-file">Upload File Content</a> API with the <code>id</code> returned from the previous step in order to add content to this File.</li></ol>Once a File is created and both steps outlined above have been successfully completed, then the File's <code>contentAvailable</code> property will be <code>true</code>, the File will be considered 'usable', and it can be referenced in specific locations of a Scan Config using its <code>id</code>. <br />A File's <code>type</code> can only be one of 6 options: <table> <thead><tr> <th>File Type</th> <th>File Extensions</th> </tr> </thead> <tbody> <tr><td><code>MACRO</code></td> <td><code>rec</code></td> </tr> <tr> <td><code>SWAGGER</code></td> <td><code>json</code><br/> <code>yaml</code><br/> <code>yml</code></td> </tr> <tr><td><code>SELENIUM</code></td> <td><code>htm</code><br/> <code>html</code><br/> <code>side</code></td> </tr> <tr><td><code>RECORDED_TRAFFIC</code></td> <td><code>trec</code><br/> <code>xml</code><br/> <code>txt</code><br/> <code>har</code><br/> <code>saz</code></td> </tr> <tr><td><code>WSDL</code></td> <td><code>wsdl</code></td> </tr> <tr><td><code>CERTIFICATE</code></td> <td><code>pfx</code></td> </tr> <tr><td><code>GRAPHQL</code></td> <td><code>qls</code><code>graphqls</code></td> </tr> <tbody> </table>Heuristic analysis is performed when file contents are uploaded to ensure that the content-type is appropriate for the file type specified; this is done for security reasons, and under no circumstances is the content sent to an external entity. <br />A note on security: a File can be <code>locked</code>, implying that it can only be modified by its owner (the original API client that created the metadata) and by extension only the File's owner is capable of uploading its content. If a File is <code>unlocked</code> any other client that has access to the File's App can make modifications, including overwriting its content.

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/rapid7/refs/heads/main/openapi/rapid7-files-api-openapi.yml

## Other Rapid7 APIs (12)

- [Rapid7 InsightVM Cloud API](https://apis.io/apis/rapid7/insightvm-api/)
- [Rapid7 Insight Platform API](https://apis.io/apis/rapid7/insight-platform-api/)
- [Rapid7 InsightIDR API](https://apis.io/apis/rapid7/insightidr-api/)
- [Rapid7 Accounts API](https://apis.io/apis/rapid7/rapid7-accounts-api/)
- [Rapid7 Administration API](https://apis.io/apis/rapid7/rapid7-administration-api/)
- [Rapid7 Apps API](https://apis.io/apis/rapid7/rapid7-apps-api/)
- [Rapid7 Asset API](https://apis.io/apis/rapid7/rapid7-asset-api/)
- [Rapid7 Asset Discovery API](https://apis.io/apis/rapid7/rapid7-asset-discovery-api/)
- [Rapid7 Asset Group API](https://apis.io/apis/rapid7/rapid7-asset-group-api/)
- [Rapid7 Assets API](https://apis.io/apis/rapid7/rapid7-assets-api/)
- [Rapid7 Attachments API](https://apis.io/apis/rapid7/rapid7-attachments-api/)
- [Rapid7 Attack Templates API](https://apis.io/apis/rapid7/rapid7-attack-templates-api/)

## Tags

File

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/rapid7/rapid7-files-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/rapid7/.