---
title: "Retrieve Load Generator by id"
method: GET
path: "/load-generator/{guid}"
tags: ["load-generators"]
---

# Retrieve Load Generator by id

`GET /load-generator/{guid}`

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

## Path parameters

- `guid` string, required

## Query parameters

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

## Response `default`

default response

- LoadGeneratorResponse
  - `identifier` string — The identifier of this load generator
  - `name` string, required — The name of the load generator to be created/updated
  - `webhookStartLoadTrigger` Webhook, required
    - `teamId` string — The identifier of the team to which this webhook belongs
    - `identifier` string — The identifier of this webhook
    - `type` 'TASK' | 'STATUS_CHECK' | 'LOAD_GENERATOR_TRIGGER' | 'LOAD_GENERATOR_STATUS_CHECK' | 'PREREQUISITE' — The type of this webhook
    - `webhookEndpoint` WebhookEndpoint — The webhook endpoint configuration for this webhook
      - `uri` string, url — The uri of this webhook endpoint
      - `headers` object — The request headers to be included when invoking this webhook endpoint
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' — The request method to be used when invoking this webhook endpoint
    - `name` string — The name of this webhook
    - `description` string — The description of this webhook
    - `createdBy` string — The identifier of the user that created this webhook
    - `createdAt` string, date-time — The time of creation of this webhook
    - `updatedBy` string — The identifier of the user that most recently updated this webhook (if applicable)
    - `updatedAt` string, date-time — The time of the most recent update for this webhook (if applicable)
    - `isPrivateNetwork` boolean — Is this webhook executed in a private network
    - `triggerEvents` string[] — The types of events that will trigger this webhook to fire
    - `state` 'ACTIVE' | 'DEACTIVATED' — The state of this webhook (ACTIVE / DEACTIVATED
    - `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
    - `multiSelectTags` object — The tags associated with this webhook
  - `webhookStatusCheck` Webhook
    - `teamId` string — The identifier of the team to which this webhook belongs
    - `identifier` string — The identifier of this webhook
    - `type` 'TASK' | 'STATUS_CHECK' | 'LOAD_GENERATOR_TRIGGER' | 'LOAD_GENERATOR_STATUS_CHECK' | 'PREREQUISITE' — The type of this webhook
    - `webhookEndpoint` WebhookEndpoint — The webhook endpoint configuration for this webhook
      - `uri` string, url — The uri of this webhook endpoint
      - `headers` object — The request headers to be included when invoking this webhook endpoint
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' — The request method to be used when invoking this webhook endpoint
    - `name` string — The name of this webhook
    - `description` string — The description of this webhook
    - `createdBy` string — The identifier of the user that created this webhook
    - `createdAt` string, date-time — The time of creation of this webhook
    - `updatedBy` string — The identifier of the user that most recently updated this webhook (if applicable)
    - `updatedAt` string, date-time — The time of the most recent update for this webhook (if applicable)
    - `isPrivateNetwork` boolean — Is this webhook executed in a private network
    - `triggerEvents` string[] — The types of events that will trigger this webhook to fire
    - `state` 'ACTIVE' | 'DEACTIVATED' — The state of this webhook (ACTIVE / DEACTIVATED
    - `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
    - `multiSelectTags` object — The tags associated with this webhook
  - `webhookStopLoadTrigger` Webhook
    - `teamId` string — The identifier of the team to which this webhook belongs
    - `identifier` string — The identifier of this webhook
    - `type` 'TASK' | 'STATUS_CHECK' | 'LOAD_GENERATOR_TRIGGER' | 'LOAD_GENERATOR_STATUS_CHECK' | 'PREREQUISITE' — The type of this webhook
    - `webhookEndpoint` WebhookEndpoint — The webhook endpoint configuration for this webhook
      - `uri` string, url — The uri of this webhook endpoint
      - `headers` object — The request headers to be included when invoking this webhook endpoint
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' — The request method to be used when invoking this webhook endpoint
    - `name` string — The name of this webhook
    - `description` string — The description of this webhook
    - `createdBy` string — The identifier of the user that created this webhook
    - `createdAt` string, date-time — The time of creation of this webhook
    - `updatedBy` string — The identifier of the user that most recently updated this webhook (if applicable)
    - `updatedAt` string, date-time — The time of the most recent update for this webhook (if applicable)
    - `isPrivateNetwork` boolean — Is this webhook executed in a private network
    - `triggerEvents` string[] — The types of events that will trigger this webhook to fire
    - `state` 'ACTIVE' | 'DEACTIVATED' — The state of this webhook (ACTIVE / DEACTIVATED
    - `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
    - `multiSelectTags` object — The tags associated with this webhook
  - `active` boolean — Load generator is active

## Other responses

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

---

[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/70fe938a0b35/schema)