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

Gremlin services API

Get metrics about intelligent health check target for a service

Gremlin services 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 Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 25 operations across 18 paths, and defines 49 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.

25 operations 18 paths 49 schemas 5 DELETE10 GET3 PATCH6 POST1 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
Terms of Service
Resource Areas
1

Paths & Operations 25

Across 18 paths, the API surfaces 25 operations — 5 DELETE, 10 GET, 3 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

services 25

Get metrics about intelligent health check target for a service

GET
/services/{serviceId}/metrics/{awsResource}
Requires the privilege [SERVICESREAD](https://www.gremlin.com/docs/user-management/access-control/privileges)
getMetrics 6 params → default403401
GET
/services/{serviceId}/dependencies
Paginated endpoint for listing active dependencies for a given service
getActiveDependencies 4 params → default403401
POST
/services/{serviceId}/dependencies
Manually define a new dependency for a given Service
defineDependency 2 params body → default403401
DELETE
/services/{serviceId}/dependencies/discovered
Deletes all discovered dependencies, including those marked as ignored, for the specified service. Halts any active runs if necessary and updates the service's reliability score.
deleteAllDiscoveredDependencies 3 params → default403401
GET
/services/{serviceId}/dependencies/ignored
Paginated endpoint for listing ignored dependencies for a given service
getIgnoredDependencies 4 params → default403401
DELETE
/services/{serviceId}/dependencies/ignored
Delete all dependencies that are marked ignored
deleteAllIgnoredDependencies 2 params → default403401
DELETE
/services/{serviceId}/dependencies/{dependencyId}
Mark a dependency as ignored, removing it from the list of active dependencies and reliability score.
deleteDependency 3 params → default403401
PATCH
/services/{serviceId}/dependencies/{dependencyId}
Update a dependency's name and/or isSPOF flag. We deliberately do not allow updating a dependency's endpoint, i.e. address and port, because updating either of these values effectively changes the de…
updateDependency 3 params body → 200400401404403
DELETE
/services/{serviceId}/dependencies/ignored/{dependencyId}
Delete a dependency that is marked as ignored
deleteIgnoredDependency 3 params → default403401
PUT
/services/{serviceId}/dependencies/{dependencyId}/namedeprecated
Requires the privilege [SERVICESWRITE](https://www.gremlin.com/docs/user-management/access-control/privileges)
renameDependency 3 params body → default403401
GET
/services
Paginated endpoint for fetching services for a given team
getAllServices 3 params → default403401
POST
/services
Create a service
createService 1 param body → default403401
PATCH
/services
Bulk add a given Status Check to all services
bulkAddHealthChecksToServices 1 param body → 200400401404403
POST
/services/bulk-create-with-load-balancers
Bulk create services based on AWS Load balancers
bulkCreateWithLoadBalancers 1 param body → default403401
POST
/services/bulk-delete
Bulk delete services
bulkDeleteServices 1 param body → default403401
POST
/services/service-creation-readiness/clients
Retrieves clients for a potential service definition
computeServiceReadinessAgentsFromPodUIDs 1 param body → default403401
GET
/services/{serviceId}
Retrieve a service by id
getService 2 params → 404403401
DELETE
/services/{serviceId}
Permanently delete a service
delete_6 2 params → default403401
PATCH
/services/{serviceId}
Update a service, editing some fields
update_4 2 params body → 200404403401
GET
/services/all-for-company
Paginated endpoint for fetching services for a given company
getAllServicesForCompany 2 params → default403401
GET
/services/{id}/risk-summary
Load risk evaluations for service. Re-evaluate risks if service has been deployed since the last evaluation.
getRiskSummary 2 params → default403401
GET
/services/service-creation-readiness/{targetType}deprecated
Requires the privilege [SERVICESWRITE](https://www.gremlin.com/docs/user-management/access-control/privileges)
getServiceCreationReadiness 2 params → default403401
GET
/services/{serviceId}/score
Retrieve a service's score in plain/text
getServiceScore 2 params → 404403401
GET
/services/{serviceId}/status-checks
Fetch Status Checks associated with a given service
getStatusChecksForService 2 params → default403401
POST
/services/{serviceId}/baseline
Run RM tests for a given service
runAllTests 2 params body → default403401

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are UserDefinedServiceResponse (33 properties), DependencyResponse (15 properties), UserDefinedServiceRequest (14 properties), ServiceUpdateRequest (13 properties). Each schema is shown below with its type and property counts.

Trigger
object
2 properties 2 required
TestSeriesRunResponse
object
9 properties
ScheduleSettings
object
4 properties
ServiceStatusCheckResponse
object
3 properties
ServiceFromLoadBalancerRequest
object
3 properties 3 required
LoadBalancerState
object
4 properties
BulkDeleteRequest
object
1 property 1 required
ServiceCreationReadinessResponse
object
2 properties
MetricResponse
object
2 properties
LoadGenerator
object
7 properties
DependencyEndpoint
object
2 properties
BulkCreateServicesFromLoadBalancersRequest
object
2 properties
HasCompareFunctionObject
object
DefineDependencyRequest
object
4 properties 2 required
GremlinAwsStatusCheckMetadata
object
6 properties
AwsHealthCheckDefinition
object
5 properties
DefaultJiraIssueFields
object
7 properties 4 required
ScheduleWindow
object
2 properties 2 required
StartBaselineRequest
object
Represents a request to run all tests
1 property
ServiceReadinessAgentsFromPodUIDsRequest
object
2 properties
ResponseBodyEvaluation
object
The configuration for evaluating the success of a response body
2 properties 2 required
ServiceUpdateRequest
object
13 properties
ApplicationSelector
object
1 property 1 required
SpofAudit
object
2 properties
PagedResponseDependencyResponse
object
4 properties
RiskSummaryStats
object
4 properties
MetricDataQuery
object
UserDefinedServiceRequest
object
14 properties 1 required
StatsByDateTime
object
2 properties
TestEligibleToRun
object
4 properties
Graph
object
4 properties
DetailedServiceRiskSummaryResponse
object
3 properties
ThresholdStrategy
object
1 property 1 required
DependencyResponse
object
15 properties
PagedResponseUserDefinedServiceResponse
object
4 properties
CategoryAudit
object
2 properties
AwsTarget
object
7 properties
TargetingStrategy
object
1 property 1 required
UserDefinedServiceResponse
object
33 properties
ServiceOwner
object
1 property
RiskEvaluationResponse
object
6 properties
ServiceCreationReadinessForOwnedAndSharedAssetsResponse
object
3 properties
EvaluationConfiguration
object
The configuration for evaluating the success/failure of a status check
3 properties 1 required
TeamExternalIntegrationReference
object
Represents the configuration for referencing an external integration
4 properties 1 required
ServiceReadinessClientsResponse
object
1 property
UpdateDependencyRequest
object
2 properties
PredicateObject
object
The list of predicates to evaluate against the status check response body
4 properties 3 required
BulkUpdateRequest
object
2 properties 2 required
ServiceStatusCheck
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gremlin-services-api-openapi.yml Raw ↑

Other APIs Gremlin publishes across the network.

Gremlin agents API
Gremlin apikeys API
Gremlin attacks API
Gremlin aws.metadata API
Gremlin clients API
Gremlin companies API
Gremlin containers API
Gremlin datadog API
Gremlin disaster-recovery-test-reports API
Gremlin disaster-recovery-tests API
Gremlin executions API
Gremlin external-integrations API
Where this information came from

This is an independent, third-party profile of Gremlin services 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.