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

Zuplo API Keys - Keys API

This is an object representing an API key. This section includes a list of endpoints to perform CRUD operations on an API key. You can learn more about API keys [here](https://zuplo.com/docs/articles/api-key-management#api-keys).

Zuplo API Keys - Keys API is one of 13 APIs that Zuplo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

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

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

Requests are made against a single base URL, https://dev.zuplo.com.

6 operations 3 paths 9 schemas 1 DELETE2 GET1 PATCH2 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://dev.zuplo.com
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Zuplo API Keys - Keys API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key authentication. Format: Bearer {api-key}

Paths & Operations 6

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

API Keys - Keys 6

This is an object representing an API key. This section includes a list of endpoints to perform CRUD operations on an API key. You can learn more about API keys [here](https://zup…

GET
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys
Lists Keys
ApiKeyKeysService_list 6 params → 200400401429500
POST
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys
Creates an API Key
ApiKeyKeysService_create 3 params body → 200400401429500
POST
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/$bulk
Creates Multiple API Keys
ApiKeyKeysService_bulkCreate 3 params body → 200400401429500
GET
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}
Gets an API Key
ApiKeyKeysService_get 6 params → 200400401404429500
PATCH
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}
Updates an API Key
ApiKeyKeysService_update 5 params body → 200400401404429500
DELETE
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}
Deletes an API Key
ApiKeyKeysService_delete 5 params → 204400401404429500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Zuplo.ApiKeys.ApiKey (6 properties), Zuplo.ApiKeys.ApiKeys (4 properties), Zuplo.ApiKeys.ApiKeyCreateOrUpdateBody (3 properties), Zuplo.HttpProblemDetails.InternalServerErrorProblemResponse (2 properties). Each schema is shown below with its type and property counts.

Zuplo.ApiKeys.ApiKeyCreateOrUpdateBody
object
3 properties
Zuplo.HttpProblemDetails.NotFoundProblemResponse
object
2 properties 2 required
Zuplo.HttpProblemDetails.UnauthorizedProblemResponse
object
2 properties 2 required
Zuplo.HttpProblemDetails.InternalServerErrorProblemResponse
object
2 properties 2 required
ApiKeyBulkCreateOrUpdateBody
array
Zuplo.ApiKeys.ApiKey
object
A Consumer can have any number of API keys associated with it. Each API Key shares the same identity (i.e. Consumer) when authenticating with this service. Key…
6 properties 3 required
Zuplo.HttpProblemDetails.BadRequestProblemResponse
object
2 properties 2 required
Zuplo.ApiKeys.KeyFormat
string
Zuplo.ApiKeys.ApiKeys
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Zuplo publishes across the network.

Zuplo API Keys - Buckets API
Zuplo API Keys - Consumers API
Zuplo API Keys - Managers API
Zuplo Audit Logs API
Zuplo Custom Domains API
Zuplo Deployments API
Zuplo MCP Servers API
Zuplo Openapi API
Zuplo Tunnel Services API
Zuplo Tunnels API
Zuplo Variables API
Zuplo Who Am I API