Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Skip to Content
API ReferenceAccount and accessTransfers

Start a resource transfer (owner/admin)

Offers one of the org's VMs to another organization, named by targetOrgSlug, and returns the pending transfer, which can be accepted for 7 days. A VM can have one unexpired pending transfer at a time; a second returns 409, as does an inference serving replica. Naming the caller's own org returns 400. An organization under review or being verified cannot offer a VM: the offer answers 403 ACCOUNT_RESTRICTED or ACCOUNT_PENDING_VERIFICATION.

Required permission

Requires the transfer.manage permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl transfers create --resource-id <resource-id> --resource-type <resource-type> --target-org-slug <target-org-slug>
POST
/v1/orgs/{orgId}/transfers

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string

Request Body

application/json
  1. body
resourceType*"vm"
Value in"vm"
resourceId*string
targetOrgSlug*string
note?string

Response Body

Created

application/json
  1. response
id*string
resourceType*string
vmId?string
sourceOrganizationId*string
targetOrganizationId*string
initiatedBy?string
respondedBy?string
status*string
note?string
createdAt*string
respondedAt?string
completedAt?string
expiresAt?string
Example Request
curl -X POST 'https://api.openrelay.inc/v1/orgs/string/transfers' \  -H 'Content-Type: application/json' \  -d '{  "resourceType": "vm",  "resourceId": "string",  "targetOrgSlug": "string"}'
Example Response
{  "id": "string",  "resourceType": "string",  "vmId": "string",  "sourceOrganizationId": "string",  "targetOrganizationId": "string",  "initiatedBy": "string",  "respondedBy": "string",  "status": "string",  "note": "string",  "createdAt": "string",  "respondedAt": "string",  "completedAt": "string",  "expiresAt": "string"}