As an alternative to the ChaosSearch console, the ChaosSearch API offers RESTful endpoints to manage object groups, views, user access, indexing, and to list permitted cloud-storage buckets and their objects. The API offers ChaosSearch and AWS-style interfaces, and is built to provide interoperability with the S3 service. Most of the API calls and parameters will look familiar to those who have used AWS endpoints to create and manage S3 buckets.

Open the ChaosSearch API Reference

Important Considerations

Authentication

ChaosSearch APIs require authentication using API keys or JWT tokens using Amazon-style request signing. If you have questions, please contact our Customer Success team.

Timeouts and Redirects

When using API calls in scripted programs, be sure to plan for the default 60-second query timeout behavior and for other possible redirects that could be returned as part of in-progress heartbeat of the various API calls.

For queries, the system returns HTTP 307 redirects to keep a heartbeat going for a limited number of times before the query times out. The client the API must redirect as instructed by the service response. The program must make a new request to the endpoint with the parameters in the response.

Response Codes

See Response for a list of API response codes.