Gremlin
Gremlin is a chaos engineering platform that helps teams build more resilient systems by running controlled failure experiments. It provides tools to simulate infrastructure failures, network issues, and resource exhaustion to identify and fix weaknesses before they cause real outages.
1 APIs
0 Features
Chaos EngineeringFault InjectionInfrastructure TestingReliabilitySite Reliability Engineering
APIs
Gremlin API
The Gremlin Failure-as-a-Service API for programmatically running chaos engineering attacks, scenarios, reliability tests, disaster recovery experiments, and managing teams, int...
Collections
Gremlin API
OPENPricing Plans
Rate Limits
FinOps
Gremlin Finops
FINOPSAPI Governance Rules
Resources
👥
GitHubOrganization
GitHubOrganization
🌐
Portal
Portal
🔗
Documentation
Documentation
🚀
GettingStarted
GettingStarted
🔑
Authentication
Authentication
💰
Pricing
Pricing
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
💬
Support
Support
🔗
LlmsText
LlmsText
Sources
opencollection: 1.0.0
info:
name: Gremlin API
version: '1.0'
items:
- info:
name: attacks
type: folder
items:
- info:
name: List all active attacks.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/attacks/active
params:
- name: source
value: Adhoc
type: query
description: Filter attacks to either adhoc or scenario.
- name: pageSize
value: ''
type: query
description: This value determines how many results will be returned per call.
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: 'This endpoint will return all active attacks for the team.
Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: Return a page of active ad-hoc experiments.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/attacks/active/paged
params:
- name: pageSize
value: None (defaults to 1000)
type: query
description: This value determines how many results will be returned per call.
- name: pageToken
value: None (returns first page)
type: query
description: Pass the pageToken to get the next page of active ad-hoc experiments
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: 'This endpoint will return a paged response of active ad-hoc experiments for a team.
Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: Add annotations to an attack
type: http
http:
method: PUT
url: https://api.gremlin.com/v1/attacks/:guid/annotations
params:
- name: guid
value: ''
type: path
description: This value represents the globally unique identifier of the record to fetch.
- name: teamId
value: ''
type: query
description: Required when using company session token.
body:
type: json
data: '{}'
docs: Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: List all attacks.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/attacks
params:
- name: source
value: Adhoc
type: query
description: Filter attacks to either adhoc or scenario.
- name: pageSize
value: ''
type: query
description: This value determines how many results will be returned per call.
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Create a new attack.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/attacks
params:
- name: teamId
value: ''
type: query
description: Required when using company session token.
body:
type: json
data: '{}'
docs: 'Create a new attack by specifying the attack configuration, targets and sampling configuration
Requires the privilege [`EXPERIMENTS_RUN`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: Idempotently halt all active attacks
type: http
http:
method: DELETE
url: https://api.gremlin.com/v1/attacks
docs: Idempotently halt all active attacks
- info:
name: List all attacks in a given time range (defaults to all attacks up to now)
type: http
http:
method: GET
url: https://api.gremlin.com/v1/attacks/range
params:
- name: startTime
value: ''
type: query
- name: endTime
value: ''
type: query
- name: pageSize
value: ''
type: query
description: This value determines how many results will be returned per call.
- name: pageToken
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: List all completed attacks.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/attacks/completed
params:
- name: source
value: Adhoc
type: query
description: Filter attacks to either adhoc or scenario.
- name: pageSize
value: ''
type: query
description: This value determines how many results will be returned per call.
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: 'This endpoint will return all completed attacks that the team has performed.
Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: Return a page of completed ad-hoc experiments.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/attacks/completed/paged
params:
- name: pageSize
value: None (defaults to 1000)
type: query
description: This value determines how many results will be returned per call.
- name: pageToken
value: None (returns first page)
type: query
description: Pass the pageToken to get the next page of completed ad-hoc experiments
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: 'This endpoint will return a paged response of completed ad-hoc experiments for a team.
Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: Legacy Create Attack.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/attacks/new
params:
- name: teamId
value: ''
type: query
description: Required when using company session token.
body:
type: json
data: '{}'
docs: 'Note that this endpoint is considered deprecated but is maintained for existing consumers. Please consider using
the new `POST /attacks` endpoint instead.
For a list of attack parameters, please visit: https://www.gremlin.com/docs/infrastructure-layer/attacks/#parameter-reference.
Please note that if the `labels` or `tags` fields are not provided, no filtering will be employed and an attack will
target all active clients within your team.
For more information on creating a new attack using the'
- info:
name: Get details about an attack.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/attacks/:guid
params:
- name: guid
value: ''
type: path
description: This value represents the globally unique identifier of the record to fetch.
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: 'This endpoint will allow you to get info on a specific attack based on its guid.
Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: Idempotently halt the specified active attack.
type: http
http:
method: DELETE
url: https://api.gremlin.com/v1/attacks/:guid
params:
- name: guid
value: ''
type: path
description: This value represents the globally unique identifier of the record to fetch.
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`HALT_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Idempotently halt all active attacks. This is a POST version of the DELETE operation.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/attacks/halt
body:
type: json
data: '{}'
docs: Idempotently halt all active attacks. This is a POST version of the DELETE operation.
- info:
name: Idempotently halt the specified active attack.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/attacks/:guid/halt
params:
- name: guid
value: ''
type: path
description: This value represents the globally unique identifier of the record to fetch.
- name: teamId
value: ''
type: query
description: Required when using company session token.
body:
type: json
data: '{}'
docs: Requires the privilege [`HALT_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: executions
type: folder
items:
- info:
name: Get a list of executions associated with an attack.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/executions
params:
- name: taskId
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: halts
type: folder
items:
- info:
name: Idempotently halt all active impacts across the Gremlin platform
type: http
http:
method: POST
url: https://api.gremlin.com/v1/halts
body:
type: json
data: '{}'
docs: Idempotently halt all active impacts across the Gremlin platform
- info:
name: kubernetes.attacks
type: folder
items:
- info:
name: Get an attack by it's guid
type: http
http:
method: GET
url: https://api.gremlin.com/v1/kubernetes/attacks/:guid
params:
- name: guid
value: ''
type: path
description: This value represents the globally unique identifier of the record to fetch.
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: List all attacks.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/kubernetes/attacks
params:
- name: source
value: Adhoc
type: query
description: Filter Kubernetes attacks to either Adhoc or Scenario.
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Legacy endpoint for creating K8s attacks. Please consider `POST /attacks` endpoint instead
type: http
http:
method: POST
url: https://api.gremlin.com/v1/kubernetes/attacks/new
params:
- name: teamId
value: ''
type: query
description: Required when using company session token.
body:
type: json
data: '{}'
docs: Requires the privilege [`EXPERIMENTS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Halt an active attack
type: http
http:
method: POST
url: https://api.gremlin.com/v1/kubernetes/attacks/:uid/halt
params:
- name: uid
value: ''
type: path
- name: teamId
value: ''
type: query
description: Required when using company session token.
body:
type: json
data: '{}'
docs: Requires the privilege [`HALT_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Halt all active attacks
type: http
http:
method: POST
url: https://api.gremlin.com/v1/kubernetes/attacks/halt
body:
type: json
data: '{}'
docs: Halt all active attacks
- info:
name: metadata
type: folder
items:
- info:
name: Get metadata about the Gremlin commands.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/metadata
params:
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: users.auth.mfa
type: folder
items:
- info:
name: Authenticate a user with MFA.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/users/auth/mfa/auth
params:
- name: getCompanySession
value: ''
type: query
body:
type: form-urlencoded
data:
- name: email
value: ''
- name: password
value: ''
- name: token
value: ''
- name: companyName
value: ''
docs: Authenticate a user with MFA.
- info:
name: Removes the MFA provider and secret, disabling MFA login.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/users/auth/mfa/disable
body:
type: form-urlencoded
data:
- name: email
value: ''
- name: password
value: ''
- name: token
value: ''
docs: Removes the MFA provider and secret, disabling MFA login.
- info:
name: Generate a secret key and enables it for the user.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/users/auth/mfa/enable
body:
type: form-urlencoded
data:
- name: email
value: ''
- name: password
value: ''
docs: Generate a secret key and enables it for the user.
- info:
name: Removes the MFA provider and secret, disabling MFA login.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/users/auth/mfa/forceDisable
body:
type: form-urlencoded
data:
- name: email
value: ''
docs: 'COMPANY_OWNER and COMPANY_ADMIN users only
Requires the privilege [`COMPANY_USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: Returns the enabled/disabled status and provider if set, of MFA for the user.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/users/auth/mfa/info
docs: Requires the privilege [`MINIMUM_COMPANY_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Returns the enabled/disabled status of MFA for a user.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/users/auth/mfa/:email/enabled
params:
- name: email
value: ''
type: path
docs: 'Company Owners and Admins users only
Requires the privilege [`SECURITY_REPORTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: Validate a MFA token for a user
type: http
http:
method: POST
url: https://api.gremlin.com/v1/users/auth/mfa/validate
body:
type: form-urlencoded
data:
- name: email
value: ''
- name: token
value: ''
docs: Validate a MFA token for a user
- info:
name: Notification Integrations
type: folder
items:
- info:
name: Get the integration for your company that is identified by the supplied type
type: http
http:
method: GET
url: https://api.gremlin.com/v1/integrations/:type
params:
- name: type
value: ''
type: path
docs: Requires the privilege [`COMPANY_INTEGRATIONS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Puts the integration identified by the supplied type on your company
type: http
http:
method: PUT
url: https://api.gremlin.com/v1/integrations/:type
params:
- name: type
value: ''
type: path
body:
type: json
data: '{}'
docs: Requires the privilege [`COMPANY_INTEGRATIONS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Idempotently deletes the integration associated with your company, identified by the supplied type
type: http
http:
method: DELETE
url: https://api.gremlin.com/v1/integrations/:type
params:
- name: type
value: ''
type: path
docs: Requires the privilege [`COMPANY_INTEGRATIONS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: List all integrations associated with your company
type: http
http:
method: GET
url: https://api.gremlin.com/v1/integrations
docs: Requires the privilege [`COMPANY_INTEGRATIONS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: oauth
type: folder
items:
- info:
name: Handle receiving a code from an OAuth flow.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/oauth/callback
params:
- name: code
value: ''
type: query
description: The code from authenticating with the oauth provider
- name: state
value: ''
type: query
description: The state value set when initiating the OAuth login
docs: Handle receiving a code from an OAuth flow.
- info:
name: Initiates a OAuth login.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/oauth/login
params:
- name: companyName
value: ''
type: query
description: The name of the company to authenticate too
- name: redirectUri
value: ''
type: query
description: Where to redirect the user to after authenticating, for use when authenticating via OAuth in the Gremlin
UI
docs: Initiates a OAuth login.
- info:
name: roles
type: folder
items:
- info:
name: Returns all roles and privileges
type: http
http:
method: GET
url: https://api.gremlin.com/v1/roles
docs: This operation will return all possible roles at both the team and company levels, along with their associated privileges.
- info:
name: Create a new custom role
type: http
http:
method: POST
url: https://api.gremlin.com/v1/roles
body:
type: json
data: '{}'
docs: 'This operation will create a new custom role.
Requires the privilege [`ROLES_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: Get a custom role
type: http
http:
method: GET
url: https://api.gremlin.com/v1/roles/:roleId
params:
- name: roleId
value: ''
type: path
description: identifier of the role
docs: This operation will return a custom role.
- info:
name: Update a custom role
type: http
http:
method: PATCH
url: https://api.gremlin.com/v1/roles/:roleId
params:
- name: roleId
value: ''
type: path
description: identifier of the role
body:
type: json
data: '{}'
docs: 'This operation will update a custom role.
Requires the privilege [`ROLES_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: Delete a custom role
type: http
http:
method: DELETE
url: https://api.gremlin.com/v1/roles/:roleId
params:
- name: roleId
value: ''
type: path
description: identifier of the role
docs: 'This operation will delete a custom role.
Requires the privilege [`ROLES_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)'
- info:
name: users.auth
type: folder
items:
- info:
name: Authenticate a user.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/users/auth
params:
- name: getCompanySession
value: ''
type: query
body:
type: form-urlencoded
data:
- name: email
value: ''
- name: password
value: ''
- name: companyName
value: ''
docs: Authenticate a user.
- info:
name: Invalidates a user's current session, if it exists.
type: http
http:
method: DELETE
url: https://api.gremlin.com/v1/users/auth
docs: Requires the privilege [`MINIMUM_COMPANY_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Email active company affiliations.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/users/auth/emailCompanies
params:
- name: email
value: ''
type: query
docs: Email active company affiliations.
- info:
name: Reset a user's password via email.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/users/auth/password/reset
body:
type: form-urlencoded
data:
- name: email
value: ''
docs: Reset a user's password via email.
- info:
name: Update a user's password.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/users/auth/password
body:
type: form-urlencoded
data:
- name: email
value: ''
- name: password
value: ''
- name: code
value: ''
docs: Update a user's password.
- info:
name: Update an authenticated user's password directly.
type: http
http:
method: PUT
url: https://api.gremlin.com/v1/users/auth/password
body:
type: form-urlencoded
data:
- name: currentPassword
value: ''
- name: newPassword
value: ''
docs: Requires the privilege [`MINIMUM_COMPANY_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: View SAML auth failures for the current company and optional user.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/users/auth/saml/failures
params:
- name: email
value: ''
type: query
docs: Requires the privilege [`COMPANY_SECURITY_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Gets SAML Service Provider metadata.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/users/auth/saml/metadata
params:
- name: companyName
value: ''
type: query
docs: Gets SAML Service Provider metadata.
- info:
name: aws.metadata
type: folder
items:
- info:
name: Queries Gremlin's view of Autoscaling Groups in a given AWS account
type: http
http:
method: GET
url: https://api.gremlin.com/v1/aws/metadata/autoscaling-groups
params:
- name: domain
value: ''
type: query
- name: mode
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: "This endpoint returns Gremlin's view of Autoscaling Groups in a given AWS account. The `domain` parameter refers\
\ to the AWS AccountId. \nNOTE: This endpoint may (or may not) return Autoscaling Groups which have already been assigned\
\ to Gremlin Services, or ones which we cannot assign to Gremlin Services\nRequires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
- info:
name: Returns the policy document necessary for Gremlin to access AWS resources.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/aws/metadata/iam-role
params:
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: "This endpoint provides the policy document and associated trust policies so that Gremlin can access an arbitrary\
\ AWS account. This endpoint also provides a link to a CloudFormationTemplate for applying this to your AWS account.\
\ \nSee: https://www.gremlin.com/docs/aws-quick-start-guide for more info\n\nRequires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
- info:
name: Queries Gremlin's view of Load balancers in a given AWS account
type: http
http:
method: GET
url: https://api.gremlin.com/v1/aws/metadata/load-balancers
params:
- name: domain
value: ''
type: query
- name: mode
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: "This endpoint returns Gremlin's view of Load Balancers in a given AWS account. These can then be used to create\
\ Gremlin Services or Intelligent Health checks. \nThe `domain` parameter refers to the AWS AccountId. \nNOTE: This\
\ endpoint may (or may not) return Load Balancers which have already been assigned to Gremlin Services, or ones which\
\ we cannot assign to Gremlin Services (eg. LBs with no hosts behind them)\nRequires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user"
- info:
name: datadog
type: folder
items:
- info:
name: Get a monitor by id.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/datadog/monitors/:monitorId
params:
- name: monitorId
value: ''
type: path
- name: datadogIntegrationName
value: ''
type: query
- name: domain
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Search for monitors.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/datadog/monitors
params:
- name: searchString
value: ''
type: query
- name: page
value: ''
type: query
- name: perPage
value: ''
type: query
- name: sort
value: ''
type: query
- name: datadogIntegrationName
value: ''
type: query
- name: domain
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: grafana
type: folder
items:
- info:
name: Get all alerts
type: http
http:
method: GET
url: https://api.gremlin.com/v1/grafana/alerts
params:
- name: name
value: ''
type: query
- name: grafanaUri
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Get all dashboards
type: http
http:
method: GET
url: https://api.gremlin.com/v1/grafana/dashboards
params:
- name: name
value: ''
type: query
- name: grafanaUri
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Get all rules
type: http
http:
method: GET
url: https://api.gremlin.com/v1/grafana/rules
params:
- name: name
value: ''
type: query
- name: grafanaUri
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Searches for Grafana alert monitors
type: http
http:
method: GET
url: https://api.gremlin.com/v1/grafana/monitors
params:
- name: searchString
value: ''
type: query
- name: grafanaIntegrationName
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: jira
type: folder
items:
- info:
name: Returns issues for entity ids with details.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/jira/issues
params:
- name: gremlinEntityIds
value: ''
type: query
description: A list of Gremlin entity ids
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`INTEGRATIONS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Creates new issue.
type: http
http:
method: POST
url: https://api.gremlin.com/v1/jira/issues
params:
- name: teamId
value: ''
type: query
description: Required when using company session token.
body:
type: json
data: '{}'
docs: Requires the privilege [`INTEGRATIONS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Returns total issues for entity ids with details.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/jira/issues/count
params:
- name: gremlinEntityIds
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Returns the fields and data available and required for creating issues.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/jira/issue-meta
params:
- name: projectId
value: ''
type: query
- name: issueTypeId
value: ''
type: query
- name: teamId
value: ''
type: query
description: Required when using company session token.
docs: Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)
- info:
name: Returns issues for an entity id with details.
type: http
http:
method: GET
url: https://api.gremlin.com/v1/jira/issues/services
params:
- name: gremlinEntityId
value: ''
type: query
description: A Gremlin entity id
- name: type
value: ''
type: query
- name: teamId
value: ''
type: query
des
# --- truncated at 32 KB (204 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gremlin/refs/heads/main/apis.yml