How to test API endpoints
This tCell API documentation is responsive and you can use it to test the API endpoints before calling them in your applications. To test an API endpoint:
- Go to the API Key Management page from your Insight Platform account.
- Select the User Key tab.
- Click the New User Key button and create a user key with the appropriate permissions.
- Copy the new API Key and store it carefully. For security reasons, you will not be able to view your key afterwards.
- On this API documentation website, use the left navigation bar to open the API endpoint you wish to test.
- If the API endpoint requires parameters, enter the required and optional parameters in the “BODY PARAMS” and “PATH PARAMS” sections.
- Click the authentication button that’s beside the Try It button and has an icon of a person with a lock on the side. You will be prompted for the X-API-Key. Enter your API Key.
- Click the Try It button.
- If all of the information is correct you should get a 200 OK with the response below it.
Note
This site automatically generates code to call the API in various programming languages such as Ruby, JavaScript, and Python. You can copy and paste this code in your applications but you must be careful of the following requirements:
- The automatically generated code does not contain path or body parameters by default. You must provide the necessary parameters in the required fields in order to add them to the code.
- After copying the generated code into your application, you must also provide the “X-API-Key” header in your code.
List agents
Fetches details for all seen agents (optionally matching the provided criteria).
List inline scripts
Fetches details for all seen inline scripts (matching the provided criteria).
List packages
Fetches details for all seen packages (matching the provided criteria). If a 'from' and 'to' timestamp is not provided the timeframe is considered to be the past 72 hours.
List vulnerable packages
Fetches details for all vulnerable packages for the given app_id that were active in the given timeframe. If a 'from' and 'to' timestamp is not provided the timeframe is considered to be the past 72 hours.
Add ips to blacklisted list
Add ips to the existing blacklisted ips list inside the blocked ips config
Remove ips from blacklisted list
Remove ips from the existing blacklisted ips list inside the blocked ips config