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

Temporal API Keys API

The API Keys API from Temporal — 2 operation(s) for api keys.

Temporal API Keys API is one of 7 APIs that Temporal 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 GitHub repository.

This API exposes 4 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2024-05-13-00.

Requests are made against a single base URL, https://saas-api.tmprl.cloud.

4 operations 2 paths 2 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2024-05-13-00
Server
https://saas-api.tmprl.cloud
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Temporal API Keys API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

API Keys 4
GET
/api/v1/api-keys
List Api Keys
listApiKeys 4 params → 200
POST
/api/v1/api-keys
Create an Api Key
createApiKey body → 200
GET
/api/v1/api-keys/{keyId}
Get an Api Key
getApiKey 1 param → 200
DELETE
/api/v1/api-keys/{keyId}
Delete an Api Key
deleteApiKey 1 param → 200

Schemas 2

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

ApiKey
object
5 properties
CreateApiKeyRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Temporal publishes across the network.

Temporal Server Frontend API
Temporal Async Operations API
Temporal Namespaces API
Temporal Regions API
Temporal Service Accounts API
Temporal Users API