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

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

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

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

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

3 operations 2 paths 4 schemas 2 GET1 POST

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 permissions 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 3

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

permissions 3
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

Schemas 4

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

PermissionEntity
object
3 properties 2 required
ValidationError
object
3 properties 3 required
HTTPValidationError
object
1 property
ResourcePermission
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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