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

Cancel a pending outgoing transfer (source org)

Withdraws a pending transfer the caller's org sent and marks it cancelled. A transfer that is not pending, or that this org did not send, returns 404.

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 cancel <id>
POST
/v1/transfers/{id}/cancel

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

id*string

Response Body

Cancelled

Example Request
curl -X POST 'https://api.openrelay.inc/v1/transfers/string/cancel'
Example Response
Empty

Count of pending incoming transfers GET

The number of transfers addressed to the org that are still pending, returned as count: the same transfers the incoming list returns. It includes transfers past their 7-day expiry that have not yet been accepted, rejected or cancelled.

Accept an incoming transfer (owner/admin) POST

Moves the offered VM to the caller's org and marks the transfer completed. At least one sshKeyIds entry is required; those keys replace the source org's. The source org's GitHub runner config for the VM is deleted, the LLM keys it holds for the VM are revoked, and any other pending transfer of the VM is cancelled. An expired transfer returns 400. If the VM has since moved to a third org, the transfer is cancelled and the call returns 409. The accepting organization takes the VM on as a new workload: one under review, being verified, or whose available balance is under the minimum answers 403 ACCOUNT_RESTRICTED, ACCOUNT_PENDING_VERIFICATION or INSUFFICIENT_BALANCE. One with no price for the VM's or pod's shape answers 400 INVALID_RESOURCE_SIZE, POD_ADMISSION_FAILED or TIER_NOT_PRICED, and nothing moves. When the sending organization can no longer hand the VM over, the call answers 409 TRANSFER_UNAVAILABLE. When either organization's account changes while the accept runs, it answers 409 TRANSFER_ACCOUNT_CHANGED; try again. When the VM changes while the accept runs, it answers 409 CONFLICT; try again. Each of these leaves the transfer pending, so it can still be rejected, or accepted later.