Docs Home
Getting Started
Compatibility
Installing the Gremlin Agent
Authenticating the Gremlin Agent
Configuring the Gremlin Agent
Onboarding services automatically
Using tags
Enabling DNS collection
Enabling AWS PrivateLink
Platform
Managing the Gremlin Agent
Updating Gremlin
Managing Users and Teams
Configuring Role Based Access Control (RBAC)
User Authentication via SAML and OAuth
Managing Kubernetes namespaces
Integrations
Health Checks
Dynatrace Integration
Restricting Testing Times
Command Line Interface
Reports
Private Network Integration (PNI) Agent
Managing running, scheduled, and past experiments
Gremlin Private Edition
Reliability Management
Reliability Management
Services
Dependencies
Detected Risks
Test Suites
Reliability Tests
Reliability Score
Disaster Recovery Tests
Fault Injection
Fault Injection
Targets
Experiments
Scenarios
GameDays
Failure Flags
Failure Flags
Configuring Failure Flags
Deploying Failure Flags on AWS Lambda
Deploying Failure Flags on AWS ECS
Deploying Failure Flags on Kubernetes
Deploying Failure Flags on the Istio service mesh via Envoy
Deploying Failure Flags on Pivotal Cloud Foundry (PCF)
Installing the Failure Flags SDK
Using Failure Flags by proxy
Running Failure Flags experiments
Troubleshooting Failure Flags
API Reference
Getting started with the Gremlin API
API reference: Classes, methods, & attributes
API examples
Security
Security
Container security
Release Notes
GeneralLinuxIntegration Agent for LinuxWindowsChaoHelmFailure Flags: Sidecar
Resources
Gremlin User Community SlackBlogTutorialsGlossaryHelp and support
Start your 30 day free trial.
START FOR FREE
Docs Home
API Reference
API Reference

API Reference

Gremlin provides a complete REST API for performing actions programatically. The OpenAPI spec is available at https://api.gremlin.com/v1/openapi.json.

  • Classes, methods, & attributes: the complete list of endpoints and methods in our API. Built using Swagger.
  • API Keys: how to create and use authentication keys for API requests.
  • Examples: examples on how to create and format API calls (e.g. as curl requests).
Previous
API reference: Classes, methods, & attributes
Next
On this page
Back to top
RELATED PAGES
API reference: Classes, methods, & attributes
A complete reference to the Gremlin REST API, from authenticating to running experiments. Improve reliability programmatically.
API Reference
How to use the Gremlin REST API.
Getting started with the Gremlin API
Learn how to authenticate with the Gremlin API using your username and password, MFA, or API keys.