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 One-Off Jobs API

[One-off jobs](https://render.com/docs/one-off-jobs) are standalone tasks that run to completion using the most recent successful build of an existing service.

Render One-Off Jobs 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 One-Off Jobs. 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 4 operations across 3 paths, and defines 3 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.

4 operations 3 paths 3 schemas 2 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 One-Off Jobs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

One-Off Jobs 4

[One-off jobs](https://render.com/docs/one-off-jobs) are standalone tasks that run to completion using the most recent successful build of an existing service.

GET
/services/{serviceId}/jobs
List jobs
list-job 10 params → 200400401404429500503
POST
/services/{serviceId}/jobs
Create job
post-job 1 param body → 201400401404429500503
GET
/services/{serviceId}/jobs/{jobId}
Retrieve job
retrieve-job 2 params → 200400401404429500503
POST
/services/{serviceId}/jobs/{jobId}/cancel
Cancel running job
cancel-job 2 params → 200400401404429500503

Schemas 3

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

error
object
2 properties
jobWithCursor
object
2 properties 2 required
cursor
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-one-off-jobs-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