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

Notyfi keys API

The keys API from Notyfi — 2 operation(s) for keys.

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

Tagged areas include keys. 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 8 schemas. It is described by OpenAPI 3.1.0, at version 1.2.0.

Requests are made against a single base URL, https://api.notyfi.com.

3 operations 2 paths 8 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.2.0
Base URL
https://api.notyfi.com/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Notyfi keys API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as X-Api-Key (apiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — Notyfi API key: Authorization: Bearer notyfimk...
  • apiKeyAuth — Notyfi API key as X-Api-Key.

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.

keys 3
GET
/api/v1/keys
List the caller's tenant's API keys
list_api_keys_api_v1_keys_get 2 params → 200401429403422
POST
/api/v1/keys
Mint a new API key (the plaintext is returned ONCE, here)
create_api_key_api_v1_keys_post 2 params body → 201401429403422
DELETE
/api/v1/keys/{key_id}
Revoke an API key
revoke_api_key_api_v1_keys__key_id__delete 3 params → 204401429403404422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ApiKeyCreated (8 properties), ApiKeyInfo (7 properties), ValidationError (5 properties), ErrorBody (3 properties). Each schema is shown below with its type and property counts.

HTTPValidationError
object
1 property
ApiKeyCreated
object
The mint response: :class:ApiKeyInfo plus key -- THE PLAINTEXT API KEY, RETURNED EXACTLY ONCE, IN THIS RESPONSE ONLY. Notyfi stores ONLY its sha256 hash; the p…
8 properties 2 required
ValidationError
object
5 properties 3 required
Error
object
The single error response shape for every 4xx/5xx on the contract.
1 property 1 required
CreateApiKey
object
The mint body: a human label for the new key, shown back in listings so a tenant can tell its keys apart ('CI key', 'Claude Desktop', ...).
2 properties 1 required
ErrorBody
object
3 properties 2 required
ApiKeyScope
string
The complete capability vocabulary assignable to an Atlas API key.
ApiKeyInfo
object
One API key owned by the caller's tenant (the list/read shape). NEVER carries key material: the plaintext is unrecoverable (only its sha256 hash is stored) and…
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

notyfi-keys-api-openapi.yml Raw ↑

Other APIs Notyfi publishes across the network.

Notyfi account API
Notyfi billing API
Notyfi trackers API
Notyfi webhooks API