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 Custom Domains API

Manage account custom domains and their deployment mappings

Zuplo Custom Domains 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 Custom Domains. 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 4 operations across 1 path, and defines 13 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.

4 operations 1 paths 13 schemas 1 DELETE1 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 Custom Domains 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 4

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

Custom Domains 4

Manage account custom domains and their deployment mappings

GET
/v1/accounts/{accountName}/custom-domains
Get Custom Domains
CustomDomainsService_list 1 param → 200400401500
POST
/v1/accounts/{accountName}/custom-domains
Create Custom Domain
CustomDomainsService_create 1 param body → 200400401500
PATCH
/v1/accounts/{accountName}/custom-domains
Update a Custom Domain
CustomDomainsService_update 1 param body → 200400401500
DELETE
/v1/accounts/{accountName}/custom-domains
Delete a Custom Domain
CustomDomainsService_delete 3 params → 200400401500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Zuplo.CustomDomains.CustomDomainDeployment (6 properties), Zuplo.CustomDomains.CustomDomain (6 properties), Zuplo.CustomDomains.CustomDomainCreateBody (5 properties), Zuplo.CustomDomains.CustomDomainMutationResult (5 properties). Each schema is shown below with its type and property counts.

Zuplo.CustomDomains.CustomDomainsList
object
Response containing a paginated list of custom domains.
3 properties 3 required
Zuplo.CustomDomains.CustomDomainUpdateBody
object
Request body for updating a custom domain.
3 properties 1 required
Zuplo.HttpProblemDetails.UnauthorizedProblemResponse
object
2 properties 2 required
Zuplo.HttpProblemDetails.InternalServerErrorProblemResponse
object
2 properties 2 required
Zuplo.CustomDomains.CustomDomainProvider
string
The provider backing a custom domain.
Zuplo.CustomDomains.CustomDomainDeployment
object
A deployment bound to a custom domain.
6 properties 6 required
Zuplo.CustomDomains.OwnershipVerification
object
DNS record details used to verify domain ownership.
3 properties 3 required
Zuplo.CustomDomains.CustomDomainMutationResult
object
The result of creating or updating a custom domain.
5 properties 5 required
Zuplo.HttpProblemDetails.BadRequestProblemResponse
object
2 properties 2 required
Zuplo.CustomDomains.CustomDomainStage
string
The stage exposed by a custom domain.
Zuplo.CustomDomains.CustomDomainCreateBody
object
Request body for creating a custom domain.
5 properties 1 required
Zuplo.CustomDomains.CustomDomain
object
A custom domain configured for an account.
6 properties 6 required
Zuplo.CustomDomains.CustomDomainEnvironmentType
string
The environment type targeted by a custom domain deployment.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuplo-custom-domains-api-openapi.yml Raw ↑

Other APIs Zuplo publishes across the network.

Zuplo API Keys - Buckets API
Zuplo API Keys - Consumers API
Zuplo API Keys - Keys API
Zuplo API Keys - Managers API
Zuplo Audit Logs 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