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 Services - Routes API

Add Redirect or Rewrite Rules to modify requests to your site without writing code. You can use URL parameters to capture path segments, and wildcards to redirect everything under a given path.

Render Services - Routes 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 Services - Routes. 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 2 paths, and defines 7 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 2 paths 7 schemas 1 DELETE1 GET1 PATCH1 POST1 PUT

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 Services - Routes 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 2 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Services - Routes 5

Add Redirect or Rewrite Rules to modify requests to your site without writing code. You can use URL parameters to capture path segments, and wildcards to redirect everything under…

GET
/services/{serviceId}/routes
List redirect/rewrite rules
list-routes 6 params → 200401403404406410429500
POST
/services/{serviceId}/routes
Add redirect/rewrite rules
add-route 1 param body → 201400401403404406410429
PATCH
/services/{serviceId}/routes
Update redirect/rewrite rule priority
patch-route 1 param body → 200401403404406410429500
PUT
/services/{serviceId}/routes
Update redirect/rewrite rules
put-routes 1 param body → 200400401403404406410429
DELETE
/services/{serviceId}/routes/{routeId}
Delete redirect/rewrite rule
delete-route 2 params → 204401403404406410429500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are route (5 properties), routePost (4 properties), routePut (3 properties), error (2 properties). Each schema is shown below with its type and property counts.

routePatch
object
1 property 1 required
route
object
5 properties 5 required
routeWithCursor
object
2 properties 2 required
routeType
string
routePut
object
3 properties 3 required
error
object
2 properties
routePost
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-services-routes-api-openapi.yml Raw ↑

Other APIs Render publishes across the network.

Render Audit Logs API
Render Blueprints API
Render Custom Domains 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