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

The settings API from Keep — 7 operation(s) for settings.

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

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

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

10 operations 7 paths 4 schemas 2 DELETE4 GET3 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 settings 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 10

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

settings 10
GET
/settings/webhook
Webhook Settings
webhook_settings_settings_webhook_get → 200
GET
/settings/smtp
Get Smtp Settings
get_smtp_settings_settings_smtp_get → 200
POST
/settings/smtp
Update Smtp Settings
update_smtp_settings_settings_smtp_post body → 200422
DELETE
/settings/smtp
Delete Smtp Settings
delete_smtp_settings_settings_smtp_delete → 200
POST
/settings/smtp/test
Test Smtp Settings
test_smtp_settings_settings_smtp_test_post body → 200422
PUT
/settings/apikey
Update Api Key
update_api_key_settings_apikey_put → 200
POST
/settings/apikey
Create Key
create_key_settings_apikey_post → 200
GET
/settings/apikeys
Get Keys
get_keys_settings_apikeys_get → 200
DELETE
/settings/apikey/{keyId}
Delete Api Key
delete_api_key_settings_apikey__keyId__delete 1 param → 200422
GET
/settings/sso
Get Sso Settings
get_sso_settings_settings_sso_get → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SMTPSettings (7 properties), WebhookSettings (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
HTTPValidationError
object
1 property
SMTPSettings
object
7 properties 3 required
WebhookSettings
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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