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 enrichment API

The enrichment API from Keep — 4 operation(s) for enrichment.

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

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

This API exposes 8 operations across 4 paths, and defines 7 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.

8 operations 4 paths 7 schemas 2 DELETE2 GET2 POST2 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 enrichment 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 8

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

enrichment 8
GET
/mapping
Get Rules
get_rules_mapping_get → 200
POST
/mapping
Create Rule
create_rule_mapping_post body → 200422
PUT
/mapping/{rule_id}
Update Rule
update_rule_mapping__rule_id__put 1 param body → 200422
DELETE
/mapping/{rule_id}
Delete Rule
delete_rule_mapping__rule_id__delete 1 param → 200422
GET
/extraction
Get Extraction Rules
get_extraction_rules_extraction_get → 200
POST
/extraction
Create Extraction Rule
create_extraction_rule_extraction_post body → 200422
PUT
/extraction/{rule_id}
Update Extraction Rule
update_extraction_rule_extraction__rule_id__put 1 param body → 200422
DELETE
/extraction/{rule_id}
Delete Extraction Rule
delete_extraction_rule_extraction__rule_id__delete 1 param → 200422

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are MappingRule (16 properties), ExtractionRuleDtoOut (13 properties), MappingRuleDtoOut (12 properties), ExtractionRuleDtoBase (8 properties). Each schema is shown below with its type and property counts.

HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required
MappingRuleDtoOut
object
12 properties 4 required
ExtractionRuleDtoBase
object
8 properties 2 required
MappingRule
object
16 properties 4 required
ExtractionRuleDtoOut
object
13 properties 4 required
MappingRuleDtoIn
object
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keep-enrichment-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 extraction API
Keep groups API
Keep healthcheck API
Keep incidents API
Keep Keep API API
Keep maintenance API
Keep mapping API