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

Knownwell api-keys API

The api-keys API from Knownwell — 2 operation(s) for api-keys.

Knownwell api-keys API is one of 9 APIs that Knownwell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include api-keys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against the base URL https://api.knownwell.com/ci/v1.

3 operations 2 paths 5 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.knownwell.com/ci/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Knownwell api-keys API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (APIKeyHeader).

Paths & Operations 3

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

api-keys 3
POST
/v1/api-keys
Create Api Key
create_api_key_v1_api_keys_post 1 param body → 201422
GET
/v1/api-keys
List Api Keys
list_api_keys_v1_api_keys_get 2 params → 200422
DELETE
/v1/api-keys/{key_id}
Revoke Api Key
revoke_api_key_v1_api_keys__key_id__delete 2 params → 204422

Schemas 5

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

APIKeyCreate
object
Request model for creating an API key.
5 properties 2 required
ValidationError
object
5 properties 3 required
APIKeyScope
string
API key access scope - ALL KEYS ARE READ-ONLY
APIKeyResponse
object
Response model for API key.
10 properties 9 required
HTTPValidationError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knownwell-api-keys-api-openapi.yml Raw ↑

Other APIs Knownwell publishes across the network.

Knownwell clients API
Knownwell documentation API
Knownwell health API
Knownwell portfolios API
Knownwell root API
Knownwell status API
Knownwell streams API
Knownwell topics API