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

Replicated customHostnames API

The customHostnames API from Replicated — 4 operation(s) for customhostnames.

Replicated customHostnames API is one of 22 APIs that Replicated publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include customHostnames. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an API reference.

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

Requests are made against the base URL https://api.replicated.com/vendor/v3.

5 operations 4 paths 5 schemas 1 DELETE1 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.0.0
Base URL
https://api.replicated.com/vendor/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Replicated customHostnames API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 5

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

customHostnames 5
POST
/app/{app_id}/custom-hostname
Create a custom hostname
createCustomHostname 2 params → 200400401403404
DELETE
/app/{app_id}/custom-hostname
Delete a custom hostname
deleteCustomHostname 2 params → 200400401403404
PUT
/app/{app_id}/custom-hostname/default/set
Set the default hostname
setDefaultHostname 2 params → 200400401403404
PUT
/app/{app_id}/custom-hostname/default/unset
Unset the default hostname
unsetDefaultHostname 2 params → 200400401403404
GET
/app/{app_id}/custom-hostnames
List custom hostnames for an app.
listCustomHostnames 1 param → 200400401403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are KotsAppCustomHostname (20 properties), UnsetDefaultHostnameParams (1 property), DeleteCustomHostnameParams (1 property), CreateCustomHostnameParams (1 property). Each schema is shown below with its type and property counts.

SetDefaultHostnameParams
object
1 property
CreateCustomHostnameParams
object
1 property
DeleteCustomHostnameParams
object
1 property
KotsAppCustomHostname
object
KotsAppCustomHostname represents a custom hostname configured for a kots app
20 properties
UnsetDefaultHostnameParams
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicated-customhostnames-api-openapi.yml Raw ↑

Other APIs Replicated publishes across the network.

Replicated apps API
Replicated channelReleases API
Replicated channels API
Replicated clusterAddons API
Replicated clusters API
Replicated cmx API
Replicated customers API
Replicated enterprisePortal API
Replicated externalRegistries API
Replicated instances API
Replicated networks API
Replicated notifications API