Jump to Content

API Reference

Suborbital Compute API

Suborbital Compute API Reference

Adminstrative API

/v1/token/{environment}.{userID}/{namespace}/{fnName}
- getget
/v1/functions/{environment}.{userID}/{namespace}
- getget
/v2/results/by-fqfn/{environment}.{userID}/{namespace}/{fnName}/{versionNumber}
- getget
/v2/results/by-uuid/{uuid}
- getget
/v2/result/{uuid}
- getget

Execution API

/{environment}.{userID}/{namespace}/{fnName}/{versionNumber}
- Executes the given function, with the provided body, params and state loaded into the function at runtime.post

Builder API

/api/v1/health
- Returns an OK response to indicate a healthy service (returns no body)get
/api/v1/features
- Returns a list of supported builder features. Primarily used to detect the presence of a testing service.get
/api/v1/template/{language}
- Gets the template for a new function of the given languageget
/api/v2/template/{language}/{fnName}
- Gets the template for a new function of the given language initialized with the supplied function nameget
/api/v1/build/{language}/{environment}.{userID}/{namespace}/{fnName}
- Builds the provided code using the specified language toolchainpost
/api/v1/draft/{environment}.{userID}/{namespace}/{fnName}
- Gets the draft for the specified runnableget
/api/v1/draft/{environment}.{userID}/{namespace}/{fnName}/promote
- Deploys the specified runnablepost
/api/v1/test/{environment}.{userID}/{namespace}/{fnName}
- Tests draftspost

Powered by

Returns an OK response to indicate a healthy service (returns no body)

get http://local.suborbital.network:{port}/api/v1/health

Language

URL

Click Try It! to start a request and see the response here!