FAQ

FAQs for the CloudSploit API

How can I use the CloudSploit API?
The CloudSploit API can be used by any user by generating an API key from the CloudSploit console and referring to the API documentation (https://cloudsploi...
Sun, 10 Nov, 2019 at 11:55 AM
What programming languages are supported by the API?
Because the CloudSploit API is a simple RESTful interface, it can be queried by any programming language that supports API calls.
Sun, 10 Nov, 2019 at 11:55 AM
What security measures does the CloudSploit API use?
Each API call must contain a HMAC SHA256 signature which is generated based on the path, URL parameters, and payload, signed with the API key and secret. Th...
Sun, 10 Nov, 2019 at 11:55 AM
Can I customize the permissions assigned to my API key?
Yes. By default, API keys have full API access; however, they may be restricted to making specific calls by modifying the key’s permissions from the CloudSp...
Sun, 10 Nov, 2019 at 11:55 AM
How do I add a description to my CloudSploit API key?
Descriptions can be added to any key via the CloudSploit console “API Keys” page. Only account admins can modify API keys.
Sun, 10 Nov, 2019 at 11:56 AM
What are the rate limits on the CloudSploit API?
CloudSploit does not publish rate limit information, but the existing rates should be sufficient to handle a majority of use cases. In the event you are dev...
Sun, 10 Nov, 2019 at 11:56 AM
Can I increase the rate limit from a particular IP address?
Yes. Please contact CloudSploit support and include a detailed description of your use case. A support engineer will work with you to determine an appropria...
Sun, 10 Nov, 2019 at 11:56 AM
What resources does the CloudSploit API have access to?
The CloudSploit API can be used to access any CloudSploit endpoint (feature) except for actions that impact the availability of the account (e.g. deleting t...
Sun, 10 Nov, 2019 at 11:56 AM
Can realtime (on-demand) scans be saved in the console?
Yes. Realtime scans can be run in two modes: Ephemeral Mode Background Mode For both modes, the scan is triggered via the API and an ID is returned....
Thu, 26 Mar, 2020 at 5:19 PM