Gremlin

Gremlin Scenarios API

Create, update, run, halt, and list scenarios

GitHub OpenAPI
Business capability
Disaster Recovery & Resilience BC-4220.60

Operations 30

DELETE /scenarios/{scenarioId}/runs/{runNumber}/images/{imageName} Deletes a given images associated with a given scenario #
PATCH /scenarios/{scenarioId}/runs/{runNumber}/images/{imageName} Uploads an image to a given scenario #
POST /scenarios/{guid}/archive Archive a scenario #
GET /scenarios List all runnable scenarios #
POST /scenarios Create a new scenario #
GET /scenarios/shared Get all scenarios shared with this team #
POST /scenarios/shared Create new shared scenarios #
GET /scenarios/{guid} Get details about a scenario #
PUT /scenarios/{guid} Update a scenario #
DELETE /scenarios/{guid} Delete a scenario #
GET /scenarios/active List all active scenarios #
GET /scenarios/active-runs List all active scenarios #
GET /scenarios/runs List all scenario runs for your team #
GET /scenarios/archived List all archived scenarios #
GET /scenarios/drafts List all draft scenarios #
GET /scenarios/active/paged Get a team's active FI scenario runs ordered by start time desc #
GET /scenarios/completed/paged Get a team's completed FI scenario runs ordered by start time desc #
GET /scenarios/{guid}/runs List all runs for a scenario #
POST /scenarios/{guid}/runs Run a scenario #
GET /scenarios/{guid}/runs/paged Paged list runs for a scenario. #
GET /scenarios/{guid}/runs/{runNumber} Get details about a scenario run #
GET /scenarios/{guid}/schedules Get all schedules for a scenario #
GET /scenarios/shared/{guid} Get details on a shared scenarios #
DELETE /scenarios/shared/{guid} Unshare a company shared scenario #
POST /scenarios/halt Idempotently halt all scenario runs and active attacks #
POST /scenarios/halt/{guid}/runs/{runNumber} Idempotently halt the specified scenario run #
POST /scenarios/{guid}/restore Restore an archived scenario #
PUT /scenarios/{guid}/runs/{runNumber}/resultFlags This functionality has been replaced by PUT /{guid}/runs/{runNumber}/results #
PUT /scenarios/{guid}/runs/{runNumber}/resultNotes Update the result notes of a scenario run #
PUT /scenarios/{guid}/runs/{runNumber}/results Update the results of a scenario run #

Documentation

📖
Documentation
https://www.gremlin.com/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gremlin/refs/heads/main/openapi/gremlin-scenarios-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gremlin/refs/heads/main/json-schema/gremlin-schema-index.yml

Other Resources

🔗
Rules
https://raw.githubusercontent.com/api-evangelist/gremlin/refs/heads/main/rules/gremlin-rules.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gremlin-scenarios-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gremlin-scenarios-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gremlin Scenarios API
  description: The API for interacting with the Gremlin Failure-as-a-Service platform
  termsOfService: https://www.gremlin.com/terms_of_service_2017_03_24
  contact:
    name: Gremlin Support
    email: support@gremlin.com
  license:
    name: Gremlin License
    url: https://www.gremlin.com/license_2017_03_24
  version: '1.0'
servers:
- url: https://api.gremlin.com/v1
  description: Gremlin API v1
tags:


# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gremlin/refs/heads/main/openapi/gremlin-scenarios-api-openapi.yml