Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceComputeCatalog

Locations / regions

Returns the catalog of locations (regions), each with an id, name, city, country, and region, plus latitude and longitude when they are set.

Required permission

Requires the catalog.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl catalog location list
GET
/v1/locations

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Response Body

Locations

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/locations'
Example Response
[  {    "id": "string",    "name": "string",    "city": "string",    "country": "string",    "region": "string",    "latitude": 0,    "longitude": 0  }]

VM template catalog GET

Returns the VM template catalog: each template's name, slug, OS type and version, driver version, whether it needs a GPU, and which GPU models it supports.

Overview

Prepaid balance, saved cards, deposits, and auto-recharge: read the balance and recent transactions, save or remove cards, and top up from a saved card.