Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Keep rules API

The rules API from Keep — 2 operation(s) for rules.

Keep rules API is one of 27 APIs that Keep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.2, at version 0.24.5.

Requests are made against the base URL https://api.keephq.dev.

4 operations 2 paths 3 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
0.24.5
Base URL
https://api.keephq.dev
Authentication
API Key, HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Keep rules API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-API-KEY (API Key). It accepts HTTP basic authentication (HTTPBasic). It supports OAuth 2.0 (OAuth2PasswordBearer) using the password flow.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

rules 4
GET
/rules
Get Rules
get_rules_rules_get → 200
POST
/rules
Create Rule
create_rule_rules_post body → 200422
PUT
/rules/{rule_id}
Update Rule
update_rule_rules__rule_id__put 1 param → 200422
DELETE
/rules/{rule_id}
Delete Rule
delete_rule_rules__rule_id__delete 1 param → 200422

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are RuleCreateDto (9 properties), ValidationError (3 properties), HTTPValidationError (1 property). Each schema is shown below with its type and property counts.

ValidationError
object
3 properties 3 required
HTTPValidationError
object
1 property
RuleCreateDto
object
9 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keep-rules-api-openapi.yml Raw ↑

Other APIs Keep publishes across the network.

Keep actions API
Keep alerts API
Keep auth API
Keep dashboard API
Keep deduplications API
Keep enrichment API
Keep extraction API
Keep groups API
Keep healthcheck API
Keep incidents API
Keep Keep API API
Keep maintenance API