How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Gremlin

Gremlin scenarios API

Create, update, run, halt, and list scenarios

Documentation Provider Profile APIs.io OpenAPI GitHub

Gremlin scenarios API is one of 55 APIs that Gremlin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Scenarios. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 30 operations across 23 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.gremlin.com/v1.

30 operations 23 paths 34 schemas 3 DELETE15 GET1 PATCH7 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.gremlin.com/v1
Contact
Gremlin Support
License
Gremlin License
Terms of Service
View terms
Resource Areas
1

Paths & Operations 30

Across 23 paths, the API surfaces 30 operations — 3 DELETE, 15 GET, 1 PATCH, 7 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

scenarios 30

Create, update, run, halt, and list scenarios

DELETE
/scenarios/{scenarioId}/runs/{runNumber}/images/{imageName}
Deletes a given images associated with a given scenario
deleteImage 4 params → default403401
PATCH
/scenarios/{scenarioId}/runs/{runNumber}/images/{imageName}
Uploads an image to a given scenario
addImage 4 params body → default403401
POST
/scenarios/{guid}/archive
Archive a scenario.
archive 2 params → 200404403401
GET
/scenarios
List all runnable scenarios.
getRunnable 1 param → 200403401
POST
/scenarios
Create a new scenario.
createNewScenario 1 param body → 200400402403401
GET
/scenarios/shared
Get all scenarios shared with this team.
getScenariosSharedWithTeam 1 param → 200403401
POST
/scenarios/shared
Create new shared scenarios.
createNewSharedScenario 1 param body → 201400403401
GET
/scenarios/{guid}
Get details about a scenario.
getScenario 2 params → 200404403401
PUT
/scenarios/{guid}
Update a scenario
updateScenario 2 params body → 200400402403401
DELETE
/scenarios/{guid}
Delete a scenario.
delete_4 2 params → 404400403401
GET
/scenarios/active
List all active scenarios.
getActive_1 1 param → 200403401
GET
/scenarios/active-runs
List all active scenarios.
getActiveRuns 1 param → default403401
GET
/scenarios/runs
List all scenario runs for your team.
getAllRunsForTeam 5 params → 200403401
GET
/scenarios/archived
List all archived scenarios.
getArchived 1 param → 200403401
GET
/scenarios/drafts
List all draft scenarios.
getDrafts 1 param → 200403401
GET
/scenarios/active/paged
Get a team's active FI scenario runs ordered by start time desc.
getPaginatedActiveRuns 3 params → default403401
GET
/scenarios/completed/paged
Get a team's completed FI scenario runs ordered by start time desc.
getPaginatedCompletedScenarioRuns 3 params → default403401
GET
/scenarios/{guid}/runs
List all runs for a scenario.
getRuns 4 params → 200404403401
POST
/scenarios/{guid}/runs
Run a scenario.
runScenario 2 params body → 200400402404409403401
GET
/scenarios/{guid}/runs/paged
Paged list runs for a scenario. Scenarios are monotonically increasing and use their run number as the pagination key
getRunsPaged 5 params → 404403401
GET
/scenarios/{guid}/runs/{runNumber}
Get details about a scenario run.
getScenarioRun 3 params → 200400402404403401
GET
/scenarios/{guid}/schedules
Get all schedules for a scenario.
getScenarioSchedules 2 params → 200403401
GET
/scenarios/shared/{guid}
Get details on a shared scenarios.
getSharedScenario 2 params → 200400404403401
DELETE
/scenarios/shared/{guid}
Unshare a company shared scenario.
unshareScenario 2 params → 400404403401
POST
/scenarios/halt
Idempotently halt all scenario runs and active attacks.
haltAsPost_2 1 param body → 202403401
POST
/scenarios/halt/{guid}/runs/{runNumber}
Idempotently halt the specified scenario run.
haltAsPost_3 3 params body → 202404403401
POST
/scenarios/{guid}/restore
Restore an archived scenario.
restore 2 params → 200404403401
PUT
/scenarios/{guid}/runs/{runNumber}/resultFlagsdeprecated
This functionality has been replaced by PUT /{guid}/runs/{runNumber}/results.
setScenarioRunResultFlags 3 params body → 400404403401
PUT
/scenarios/{guid}/runs/{runNumber}/resultNotes
Update the result notes of a scenario run.
setScenarioRunResultNotes 3 params body → 200400404403401
PUT
/scenarios/{guid}/runs/{runNumber}/results
Update the results of a scenario run.
setScenarioRunResults 3 params body → 200400404403401

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are ScenarioRunResponse (25 properties), ScenarioResponse (22 properties), ScenarioRunGraph (18 properties), SharedScenarioResponse (15 properties). Each schema is shown below with its type and property counts.

Selector
object
2 properties 2 required
ScenarioResponse
object
22 properties
CreateScenarioRequest
object
8 properties
HasCompareFunctionObject
object
ResponseBodyEvaluation
object
The configuration for evaluating the success of a response body
2 properties 2 required
ServiceTarget
object
2 properties 1 required
ExternalCallFailedException
object
8 properties
StatusCheckNode
object
CompletedScenarioRunResponse
object
11 properties
HaltRequest
object
2 properties
EndpointConfiguration
object
5 properties 1 required
GameDayInfo
object
2 properties
RollbackExternalActionNode
object
ScenarioRunResults
object
3 properties
TargetingStrategy
object
1 property 1 required
ExternalActionNode
object
UpdateScenarioRequest
object
5 properties
PagedResponseCompletedScenarioRunResponse
object
4 properties
ScenarioRunResponse
object
25 properties
PagedResponseScenarioRunResponse
object
4 properties
FormDataContentDisposition
object
8 properties
StatusCheckNodeRequest
object
1 property
EvaluationConfiguration
object
The configuration for evaluating the success/failure of a status check
3 properties 1 required
FailureFlagTarget
object
4 properties
State
object
6 properties
ScenarioGraph
object
11 properties
ScenarioScheduleResponse
object
14 properties
GraphNodeObject
object
5 properties
SharedScenarioResponse
object
15 properties
PredicateObject
object
The list of predicates to evaluate against the status check response body
4 properties 3 required
ExternalActionRequest
object
2 properties 1 required
TargetSampling
object
1 property 1 required
RunScenarioRequest
object
1 property
ScenarioRunGraph
object
18 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gremlin-scenarios-api-openapi.yml Raw ↑

Other APIs Gremlin publishes across the network.

Gremlin agents API
AE Profile APIs.io
Gremlin apikeys API
AE Profile APIs.io
Gremlin attacks API
AE Profile APIs.io
Gremlin aws.metadata API
AE Profile APIs.io
Gremlin clients API
AE Profile APIs.io
Gremlin companies API
AE Profile APIs.io
Gremlin containers API
AE Profile APIs.io
Gremlin datadog API
AE Profile APIs.io
Gremlin disaster-recovery-test-reports API
AE Profile APIs.io
Gremlin disaster-recovery-tests API
AE Profile APIs.io
Gremlin executions API
AE Profile APIs.io
Gremlin external-integrations API
AE Profile APIs.io
#Scenarios
← Back to G APIs
API Details
ID
gremlin:gremlin-scenarios-api
Base URL
https://api.gremlin.com/v1
Docs
https://www.gremlin.com/docs
Provider
Gremlin
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=gremlin-scenarios-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gremlin-scenarios-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Gremlin scenarios API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.