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

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

Zuplo API Keys - Buckets 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 - Buckets. 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 5 operations across 2 paths, and defines 8 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.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 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 - Buckets 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 5

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

API Keys - Buckets 5

A Bucket is an object representing a group of API key consumers for a given account. This section includes a group of endpoints available to perform CRUD operations on a bucket. Y…

GET
/v1/accounts/{accountName}/key-buckets
Lists Buckets
ApiKeyBucketsService_list 1 param → 200400401429500
POST
/v1/accounts/{accountName}/key-buckets
Creates a Bucket
ApiKeyBucketsService_create 1 param body → 200400401429500
GET
/v1/accounts/{accountName}/key-buckets/{bucketName}
Gets a Bucket
ApiKeyBucketsService_read 2 params → 200400401404429500
PATCH
/v1/accounts/{accountName}/key-buckets/{bucketName}
Updates a Bucket
ApiKeyBucketsService_update 2 params body → 200400401404429500
DELETE
/v1/accounts/{accountName}/key-buckets/{bucketName}
Deletes a Bucket
ApiKeyBucketsService_delete 2 params → 204400401404429500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Zuplo.ApiKeys.Bucket (7 properties), Zuplo.ApiKeys.Buckets (4 properties), Zuplo.ApiKeys.BucketCreateBody (3 properties), Zuplo.HttpProblemDetails.NotFoundProblemResponse (2 properties). Each schema is shown below with its type and property counts.

Zuplo.ApiKeys.BucketUpdateBody
object
2 properties
Zuplo.HttpProblemDetails.InternalServerErrorProblemResponse
object
2 properties 2 required
Zuplo.HttpProblemDetails.UnauthorizedProblemResponse
object
2 properties 2 required
Zuplo.ApiKeys.Buckets
object
4 properties 1 required
Zuplo.ApiKeys.Bucket
object
Top level group for API key mangement. A bucket could be used with a single Zuplo environment or shared among multiple environments or projects. By default a Z…
7 properties 4 required
Zuplo.ApiKeys.BucketCreateBody
object
3 properties 1 required
Zuplo.HttpProblemDetails.BadRequestProblemResponse
object
2 properties 2 required
Zuplo.HttpProblemDetails.NotFoundProblemResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Zuplo publishes across the network.

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