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

Hopae, Inc. Console - API Keys API

Workspace API key management (Console)

Hopae, Inc. Console - API Keys API is one of 9 APIs that Hopae, Inc. publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://sandbox.api.hopae.com/connect.

4 operations 3 paths 3 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://sandbox.api.hopae.com/connect
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 5

Hopae, Inc. Console - API Keys API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (API Key) (workspaceApiKey). It accepts HTTP bearer tokens (JWT) (consoleJwt). It accepts HTTP bearer tokens (JWT) (workspace-api-key). It accepts HTTP basic authentication (app-basic).

  • basicAuth — Basic authentication using clientId and clientSecret. For direct API calls, format the Authorization header as Authorization: Basic . In the Mintlify playgroun…
  • workspaceApiKey — Workspace API key authentication. Pass your workspace API key as Authorization: Bearer skworkspace....
  • consoleJwt — Console JWT authentication. Issued by Clerk after Console login.

Paths & Operations 4

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

Console - API Keys 4

Workspace API key management (Console)

POST
/v1/console/api-keys
Create workspace API key
ConsoleController_createApiKey body → 201401
GET
/v1/console/api-keys
List workspace API keys
ConsoleController_listApiKeys → 200401
POST
/v1/console/api-keys/{id}/revoke
Revoke API key
ConsoleController_revokeApiKey 1 param → 200401404
DELETE
/v1/console/api-keys/{id}
Delete API key
ConsoleController_deleteApiKey 1 param → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ApiKeyResponseDto (6 properties), CreateApiKeyDto (1 property), RevokeApiKeyResponseDto (1 property). Each schema is shown below with its type and property counts.

RevokeApiKeyResponseDto
object
1 property 1 required
CreateApiKeyDto
object
1 property 1 required
ApiKeyResponseDto
object
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hopae-inc-console-api-keys-api-openapi.yml Raw ↑

Other APIs Hopae, Inc. publishes across the network.

Hopae, Inc. Providers API
Hopae, Inc. Token API
Hopae, Inc. Verifications API
Hopae, Inc. Workspace API - Activation API
Hopae, Inc. Workspace API - Apps API
Hopae, Inc. Workspace API - Production Tests API
Hopae, Inc. Workspace API - Workflows API
Hopae, Inc. Workspace API - Workspace API