---
title: "Update a given Load Generator"
method: PUT
path: "/load-generator/{guid}"
tags: ["load-generators"]
---

# Update a given Load Generator

`PUT /load-generator/{guid}`

Requires the privilege [`WEBHOOKS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)

## Path parameters

- `guid` string, required

## Query parameters

- `serviceId` string, required
- `teamId` string, required

## Request body

- LoadGeneratorRequest
  - `identifier` string — The identifier of this load generator
  - `name` string, required — The name of the load generator to be created/updated
  - `webhookStartLoadTrigger` WebhookRequest, required
    - `identifier` string — The identifier of this webhook
    - `name` string, required — The name of the webhook to be created/updated
    - `description` string — The description of the webhook to be created/updated
    - `isPrivateNetwork` boolean
    - `uri` string, url, required — The URI of the webhook
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH', required — The HTTP request method to use when the webhook is invoked
    - `headers` object — Optional request headers to be used when the webhook is invoked
    - `triggerEvents` string[] — The list of attack events that should cause the webhook to be invoked
    - `state` 'ACTIVE' | 'DEACTIVATED' — State (active/deactivated) of the webhook
    - `payload` string — The payload to be sent when the webhook is invoked
    - `teamExternalIntegration` TeamExternalIntegrationReference — Represents the configuration for referencing an external integration
      - `type` 'JIRA' | 'DATADOG' | 'DATADOG_EU' | 'DATADOG_US3' | 'DATADOG_US5' | 'DATADOG_US1_FED' | 'PAGERDUTY' | 'NEWRELIC' | 'GRAFANA' | 'DYNATRACE' | 'APPDYNAMICS' | 'PROMETHEUS' | 'CUSTOM' | 'K6' | 'LOAD_GENERATOR_CUSTOM' | 'AWS' | 'AZURE' | 'GCP' — The type of the external integration for the health check to be created/updated
      - `observabilityToolType` 'DATADOG' | 'PAGERDUTY' | 'NEWRELIC' | 'GRAFANA' | 'DYNATRACE' | 'APPDYNAMICS' | 'PROMETHEUS' | 'CUSTOM' | 'AWS' | 'AZURE' — The observability tool type of the external integration for the health check to be created/updated
      - `domain` string — The domain of the observability tool type of the external integration for the health check to be created/updated
      - `name` string, required — The name of the external integration for the health check to be created/updated
    - `evaluationConfiguration` EvaluationConfiguration — The configuration for evaluating the success/failure of a status check
      - `okLatencyMaxMs` integer — The maximum latency in milliseconds for a successful status check
      - `okStatusCodes` string[], required — The list of successful response status codes for a successful status check
      - `responseBodyEvaluation` ResponseBodyEvaluation — The configuration for evaluating the success of a response body
        - `op` 'AND' | 'OR', required — The operation to logically combine predicates into a success or failure
        - `predicates` PredicateObject[], required — The list of predicates to evaluate against the status check response body
          - `comparator` HasCompareFunctionObject
          - `type` 'String' | 'Number' | 'Boolean', required — The type of primitive this predicate operates on
          - `jpQuery` string, required — The json path query to run to read from the response body
          - `rValue` object, required — The right hand value of the predicate
    - `type` 'TASK' | 'STATUS_CHECK' | 'LOAD_GENERATOR_TRIGGER' | 'LOAD_GENERATOR_STATUS_CHECK' | 'PREREQUISITE' — The type of this webhook
    - `multiSelectTags` object — The tags associated with this webhook
  - `webhookStatusCheck` WebhookRequest
    - `identifier` string — The identifier of this webhook
    - `name` string, required — The name of the webhook to be created/updated
    - `description` string — The description of the webhook to be created/updated
    - `isPrivateNetwork` boolean
    - `uri` string, url, required — The URI of the webhook
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH', required — The HTTP request method to use when the webhook is invoked
    - `headers` object — Optional request headers to be used when the webhook is invoked
    - `triggerEvents` string[] — The list of attack events that should cause the webhook to be invoked
    - `state` 'ACTIVE' | 'DEACTIVATED' — State (active/deactivated) of the webhook
    - `payload` string — The payload to be sent when the webhook is invoked
    - `teamExternalIntegration` TeamExternalIntegrationReference — Represents the configuration for referencing an external integration
      - `type` 'JIRA' | 'DATADOG' | 'DATADOG_EU' | 'DATADOG_US3' | 'DATADOG_US5' | 'DATADOG_US1_FED' | 'PAGERDUTY' | 'NEWRELIC' | 'GRAFANA' | 'DYNATRACE' | 'APPDYNAMICS' | 'PROMETHEUS' | 'CUSTOM' | 'K6' | 'LOAD_GENERATOR_CUSTOM' | 'AWS' | 'AZURE' | 'GCP' — The type of the external integration for the health check to be created/updated
      - `observabilityToolType` 'DATADOG' | 'PAGERDUTY' | 'NEWRELIC' | 'GRAFANA' | 'DYNATRACE' | 'APPDYNAMICS' | 'PROMETHEUS' | 'CUSTOM' | 'AWS' | 'AZURE' — The observability tool type of the external integration for the health check to be created/updated
      - `domain` string — The domain of the observability tool type of the external integration for the health check to be created/updated
      - `name` string, required — The name of the external integration for the health check to be created/updated
    - `evaluationConfiguration` EvaluationConfiguration — The configuration for evaluating the success/failure of a status check
      - `okLatencyMaxMs` integer — The maximum latency in milliseconds for a successful status check
      - `okStatusCodes` string[], required — The list of successful response status codes for a successful status check
      - `responseBodyEvaluation` ResponseBodyEvaluation — The configuration for evaluating the success of a response body
        - `op` 'AND' | 'OR', required — The operation to logically combine predicates into a success or failure
        - `predicates` PredicateObject[], required — The list of predicates to evaluate against the status check response body
          - `comparator` HasCompareFunctionObject
          - `type` 'String' | 'Number' | 'Boolean', required — The type of primitive this predicate operates on
          - `jpQuery` string, required — The json path query to run to read from the response body
          - `rValue` object, required — The right hand value of the predicate
    - `type` 'TASK' | 'STATUS_CHECK' | 'LOAD_GENERATOR_TRIGGER' | 'LOAD_GENERATOR_STATUS_CHECK' | 'PREREQUISITE' — The type of this webhook
    - `multiSelectTags` object — The tags associated with this webhook
  - `webhookStopLoadTrigger` WebhookRequest
    - `identifier` string — The identifier of this webhook
    - `name` string, required — The name of the webhook to be created/updated
    - `description` string — The description of the webhook to be created/updated
    - `isPrivateNetwork` boolean
    - `uri` string, url, required — The URI of the webhook
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH', required — The HTTP request method to use when the webhook is invoked
    - `headers` object — Optional request headers to be used when the webhook is invoked
    - `triggerEvents` string[] — The list of attack events that should cause the webhook to be invoked
    - `state` 'ACTIVE' | 'DEACTIVATED' — State (active/deactivated) of the webhook
    - `payload` string — The payload to be sent when the webhook is invoked
    - `teamExternalIntegration` TeamExternalIntegrationReference — Represents the configuration for referencing an external integration
      - `type` 'JIRA' | 'DATADOG' | 'DATADOG_EU' | 'DATADOG_US3' | 'DATADOG_US5' | 'DATADOG_US1_FED' | 'PAGERDUTY' | 'NEWRELIC' | 'GRAFANA' | 'DYNATRACE' | 'APPDYNAMICS' | 'PROMETHEUS' | 'CUSTOM' | 'K6' | 'LOAD_GENERATOR_CUSTOM' | 'AWS' | 'AZURE' | 'GCP' — The type of the external integration for the health check to be created/updated
      - `observabilityToolType` 'DATADOG' | 'PAGERDUTY' | 'NEWRELIC' | 'GRAFANA' | 'DYNATRACE' | 'APPDYNAMICS' | 'PROMETHEUS' | 'CUSTOM' | 'AWS' | 'AZURE' — The observability tool type of the external integration for the health check to be created/updated
      - `domain` string — The domain of the observability tool type of the external integration for the health check to be created/updated
      - `name` string, required — The name of the external integration for the health check to be created/updated
    - `evaluationConfiguration` EvaluationConfiguration — The configuration for evaluating the success/failure of a status check
      - `okLatencyMaxMs` integer — The maximum latency in milliseconds for a successful status check
      - `okStatusCodes` string[], required — The list of successful response status codes for a successful status check
      - `responseBodyEvaluation` ResponseBodyEvaluation — The configuration for evaluating the success of a response body
        - `op` 'AND' | 'OR', required — The operation to logically combine predicates into a success or failure
        - `predicates` PredicateObject[], required — The list of predicates to evaluate against the status check response body
          - `comparator` HasCompareFunctionObject
          - `type` 'String' | 'Number' | 'Boolean', required — The type of primitive this predicate operates on
          - `jpQuery` string, required — The json path query to run to read from the response body
          - `rValue` object, required — The right hand value of the predicate
    - `type` 'TASK' | 'STATUS_CHECK' | 'LOAD_GENERATOR_TRIGGER' | 'LOAD_GENERATOR_STATUS_CHECK' | 'PREREQUISITE' — The type of this webhook
    - `multiSelectTags` object — The tags associated with this webhook
  - `active` boolean

## Response `default`

default response

## Other responses

- `401` — Authorization header missing or malformed. Please provide proper credentials in the authorization header.
- `403` — User requires privilege for target team: WEBHOOKS_WRITE

---

[API](https://skmtc.net/gremlin/apis/gremlin-api.md) · [All operations](https://skmtc.net/gremlin/apis/gremlin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gremlin/gremlin-api/versions/36ee938323f0/schema)