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

The providers API from Keep — 16 operation(s) for providers.

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

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

This API exposes 16 operations across 16 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.

16 operations 16 paths 3 schemas 1 DELETE7 GET7 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 providers 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 16

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

providers 16
GET
/providers
Get Providers
get_providers_providers_get → 200
GET
/providers/export
Get Installed Providers
get_installed_providers_providers_export_get → 200
GET
/providers/{provider_type}/{provider_id}/configured-alerts
Get Alerts Configuration
get_alerts_configuration_providers__provider_type___provider_id__configured_alerts_get 2 params → 200422
GET
/providers/{provider_type}/{provider_id}/logs
Get Logs
get_logs_providers__provider_type___provider_id__logs_get 3 params → 200422
GET
/providers/{provider_type}/schema
Get Alerts Schema
get_alerts_schema_providers__provider_type__schema_get 1 param → 200422
GET
/providers/{provider_type}/{provider_id}/alerts/count
Get Alert Count
get_alert_count_providers__provider_type___provider_id__alerts_count_get 5 params → 200422
POST
/providers/{provider_type}/{provider_id}/alerts
Add Alert
add_alert_providers__provider_type___provider_id__alerts_post 3 params body → 200422
POST
/providers/test
Test Provider
test_provider_providers_test_post body → 200422
DELETE
/providers/{provider_type}/{provider_id}
Delete Provider
delete_provider_providers__provider_type___provider_id__delete 2 params → 200422
POST
/providers/{provider_id}/scopes
Validate Provider Scopes
validate_provider_scopes_providers__provider_id__scopes_post 1 param → 200422
PUT
/providers/{provider_id}
Update Provider
update_provider_providers__provider_id__put 1 param → 200422
POST
/providers/install
Install Provider
install_provider_providers_install_post → 200
POST
/providers/install/oauth2/{provider_type}
Install Provider Oauth2
install_provider_oauth2_providers_install_oauth2__provider_type__post 1 param body → 200422
POST
/providers/{provider_id}/invoke/{method}
Invoke Provider Method
invoke_provider_method_providers__provider_id__invoke__method__post 2 params body → 200422
POST
/providers/install/webhook/{provider_type}/{provider_id}
Install Provider Webhook
install_provider_webhook_providers_install_webhook__provider_type___provider_id__post 2 params → 200422
GET
/providers/{provider_type}/webhook
Get Webhook Settings
get_webhook_settings_providers__provider_type__webhook_get 1 param → 200422

Schemas 3

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

ValidationError
object
3 properties 3 required
ProviderWebhookSettings
object
3 properties 1 required
HTTPValidationError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keep-providers-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