Sign in

v1

latestOpenAPI 3.0.1Gremlin License2026-08-06397451577.0 KB
attacks

Add annotations to an attack

Requires the privilege MINIMUM_TEAM_PRIVILEGES

put/attacks/{guid}/annotations

Path parameters

guidstring required

This value represents the globally unique identifier of the record to fetch.

Query parameters

teamIdstring required

Required when using company session token.

Request body

otherAnnotationsobject
notesstring

Notes about the attack

metricsstring

Link to metrics about the impact of the attack

Response

default response

orgIdstring
guidstring
argsstring[]
stage'InvalidArgument' | 'TargetNotFound' | 'Successful' | 'UserHalted' | 'ClientAborted' | 'LostCommunication' | 'InitializationFailed' | 'TeardownFailed' | 'HaltFailed' | 'Failed' | 'Pending' | 'Distributed' | 'Initializing' | 'HaltDistributed' | 'InterruptTriggered' | 'RollbackTriggered' | 'RollbackStarted' | 'Running' | 'TearingDown' | 'Halt'
createSource'WebApp' | 'Api' | 'Scheduled' | 'Manual' | 'Spinnaker' | 'Concord' | 'GremlinFeeder' | 'GremlinSdkPython' | 'Scenario' | 'Chao' | 'K8sBackend' | 'Website' | 'Neotys' | 'IntegrationClient' | 'Validation'
triggerSource'MANUAL' | 'RUN_ALL' | 'SCHEDULED' | 'RECURRING_SCHEDULE'
kind'WebApp' | 'Api' | 'Scheduled' | 'Manual' | 'Spinnaker' | 'Concord' | 'GremlinFeeder' | 'GremlinSdkPython' | 'Scenario' | 'Chao' | 'K8sBackend' | 'Website' | 'Neotys' | 'IntegrationClient' | 'Validation'
owningTeamIdstring
createSourceDetail'Onboarding'
infraTargetobject
infraCommandobject
targetsstring[]
targetContainersobject
stageLifecycle'Active' | 'Halting' | 'Complete' | 'Error'
createUserstring
executionSummariesobject
executionStageSummaryobject
tagsobject
multiSelectTagsobject
labelsobject
multiSelectLabelsobject
targetType'Host' | 'Container' | 'Docker' | 'Kubernetes'
startTimestring date-time
endTimestring date-time
initializationEndTimestring date-time
commandTemplateIdstring
targetTemplateIdstring
scenarioIdstring
scenarioRunNumberinteger
scenarioStepNumberinteger
scenarioNodeGuidstring
serviceIdstring
k8sAttackIdstring
annotationsobject
totalClientsinteger
clientMetricsEnabledCountinteger
providersstring[]
includeNewClientsboolean
continueOnEmptyTargetsboolean
dynamicallyResolvedIpsstring[]
displayErrorMessagestring
createdAtstring date-time
updatedAtstring date-time