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

The `Workspaces` endpoints supply more information about the workspaces that your API key has access to. This category was previously called `Owners`, as reflected by endpoint paths.

Render Workspaces 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 Workspaces. 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 4 paths, and defines 8 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 4 paths 8 schemas 1 DELETE3 GET1 PATCH

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

Workspaces 5

The Workspaces endpoints supply more information about the workspaces that your API key has access to. This category was previously called Owners, as reflected by endpoint paths.

PATCH
/owners/{ownerId}/members/{userId}
Update workspace member role
update-workspace-member 2 params body → 200400401403404409429500
DELETE
/owners/{ownerId}/members/{userId}
Remove workspace member
remove-workspace-member 2 params → 204400401403404429500503
GET
/owners
List workspaces
list-owners 4 params → 200401406429500503
GET
/owners/{ownerId}
Retrieve workspace
retrieve-owner 1 param → 200401404406410429500503
GET
/owners/{ownerId}/members
List workspace members
retrieve-owner-members 1 param → 200401404406410429500503

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are owner (6 properties), teamMember (6 properties), ownerWithCursor (2 properties), cidrBlockAndDescription (2 properties). Each schema is shown below with its type and property counts.

teamMemberRole
string
The member's workspace role. Values are always returned in uppercase.
owner
object
6 properties 4 required
ownerWithCursor
object
2 properties
cursor
string
teamMembers
array
cidrBlockAndDescription
object
2 properties 2 required
teamMember
object
6 properties 6 required
error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-workspaces-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