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 - Consumers API

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

Zuplo API Keys - Consumers 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 - Consumers. 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 12 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 12 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 - Consumers 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 - Consumers 6

A Consumer is an object representing a group of API keys in a given bucket. This section includes a group of endpoints available to perform CRUD operations on a consumer. You can…

GET
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers
Lists Consumers
ApiKeyConsumersService_list 10 params → 200400401429500
POST
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers
Creates a Consumer
ApiKeyConsumersService_create 3 params body → 200400401429500
GET
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}
Gets a Consumer
ApiKeyConsumersService_read 8 params → 200400401404429500
PATCH
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}
Updates a Consumer
ApiKeyConsumersService_update 4 params body → 200400401404429500
DELETE
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}
Deletes a Consumer
ApiKeyConsumersService_delete 4 params → 204400401404429500
POST
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/roll-key
Roll Consumer Keys
ApiKeyConsumersService_rollKey 4 params body → 204400401404429500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Zuplo.ApiKeys.Consumer (8 properties), Zuplo.ApiKeys.ConsumerCreateBody (6 properties), Zuplo.ApiKeys.ApiKey (6 properties), Zuplo.ApiKeys.Consumers (4 properties). Each schema is shown below with its type and property counts.

Zuplo.HttpProblemDetails.InternalServerErrorProblemResponse
object
2 properties 2 required
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.UnauthorizedProblemResponse
object
2 properties 2 required
Zuplo.HttpProblemDetails.NotFoundProblemResponse
object
2 properties 2 required
Zuplo.ApiKeys.ConsumerCreateBody
object
6 properties 1 required
Zuplo.Common.ExpiresOnField
object
1 property 1 required
Zuplo.ApiKeys.Consumers
object
4 properties 1 required
Zuplo.ApiKeys.KeyFormat
string
Zuplo.ApiKeys.Manager
object
Managers are users that have access to a consumer. Managers can be added directly to a consumer (using email and sub) or invited (using only email) to a consum…
2 properties 4 required
Zuplo.ApiKeys.Consumer
object
Consumers are the core of the API Key service. The consumer is the 'identity' of any API Keys that are created.
8 properties 4 required
Zuplo.ApiKeys.ConsumerUpdateBody
object
3 properties
Zuplo.HttpProblemDetails.BadRequestProblemResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Zuplo publishes across the network.

Zuplo API Keys - Buckets API
Zuplo API Keys - Keys 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