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

The auth API from Keep — 8 operation(s) for auth.

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

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

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

15 operations 8 paths 11 schemas 3 DELETE5 GET4 POST3 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 auth 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 15

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

auth 15
GET
/auth/groups
Get Groups
get_groups_auth_groups_get → 200
POST
/auth/groups
Create Group
create_group_auth_groups_post body → 200422
PUT
/auth/groups/{group_name}
Update Group
update_group_auth_groups__group_name__put 1 param body → 200422
DELETE
/auth/groups/{group_name}
Delete Group
delete_group_auth_groups__group_name__delete 1 param → 200422
GET
/auth/permissions
Get Permissions
get_permissions_auth_permissions_get → 200
POST
/auth/permissions
Create Permissions
create_permissions_auth_permissions_post body → 200422
GET
/auth/permissions/scopes
Get Scopes
get_scopes_auth_permissions_scopes_get → 200
GET
/auth/roles
Get Roles
get_roles_auth_roles_get → 200
POST
/auth/roles
Create Role
create_role_auth_roles_post body → 200422
PUT
/auth/roles/{role_id}
Update Role
update_role_auth_roles__role_id__put 1 param body → 200422
DELETE
/auth/roles/{role_id}
Delete Role
delete_role_auth_roles__role_id__delete 1 param → 200422
GET
/auth/users
Get Users
get_users_auth_users_get → 200
POST
/auth/users
Create User
create_user_auth_users_post body → 200422
PUT
/auth/users/{user_email}
Update User
update_user_auth_users__user_email__put 1 param body → 200422
DELETE
/auth/users/{user_email}
Delete User
delete_user_auth_users__user_email__delete 1 param → 200422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are User (8 properties), Role (5 properties), CreateUserRequest (5 properties), Group (5 properties). Each schema is shown below with its type and property counts.

User
object
8 properties 3 required
HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required
CreateUserRequest
object
5 properties 1 required
Role
object
5 properties 4 required
UpdateUserRequest
object
4 properties
PermissionEntity
object
3 properties 2 required
Group
object
5 properties 2 required
ResourcePermission
object
4 properties 4 required
CreateOrUpdateRole
object
3 properties
CreateOrUpdateGroupRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keep-auth-api-openapi.yml Raw ↑

Other APIs Keep publishes across the network.

Keep actions API
Keep alerts 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
Keep mapping API