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

Render Custom Domains API

[Custom Domains](https://render.com/docs/custom-domains) allow you to associate domain names with your Render services.

Render Custom Domains API is one of 26 APIs that Render publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Custom Domains. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 3 JSON Schemas.

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

Requests are made against a single base URL, https://api.render.com/v1.

5 operations 3 paths 4 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0.0
Base URL
https://api.render.com/v1
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Render Custom Domains API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 5

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

Custom Domains 5

[Custom Domains](https://render.com/docs/custom-domains) allow you to associate domain names with your Render services.

GET
/services/{serviceId}/custom-domains
List custom domains
list-custom-domains 8 params → 200400401403404406410429
POST
/services/{serviceId}/custom-domains
Add custom domain
create-custom-domain 1 param body → 201400401402403404406409
GET
/services/{serviceId}/custom-domains/{customDomainIdOrName}
Retrieve custom domain
retrieve-custom-domain 2 params → 200400401403404406410429
DELETE
/services/{serviceId}/custom-domains/{customDomainIdOrName}
Delete custom domain
delete-custom-domain 2 params → 204400401403404406410429
POST
/services/{serviceId}/custom-domains/{customDomainIdOrName}/verify
Verify DNS configuration
refresh-custom-domain 2 params → 202400401403404406410429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are customDomain (8 properties), error (2 properties), customDomainWithCursor (2 properties). Each schema is shown below with its type and property counts.

cursor
string
customDomain
object
8 properties 7 required
customDomainWithCursor
object
2 properties 2 required
error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Render publishes across the network.

Render Audit Logs API
Render Blueprints API
Render Deploys API
Render Disks API
Render Environment Groups API
Render Events API
Render Key Value API
Render Logs API
Render Maintenance API
Render Metrics API
Render Notification Settings API
Render One-Off Jobs API