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

Outgoing transfers, all statuses (enriched)

The transfers the org has sent, in every status, newest first and at most 50, each with the VM's name and the receiving org's name and slug.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl transfers outgoing list
GET
/v1/orgs/{orgId}/transfers/outgoing

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string

Response Body

OK

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/transfers/outgoing'
Example Response
[  {    "id": "string",    "resourceType": "string",    "vmId": "string",    "status": "string",    "note": "string",    "createdAt": "string",    "expiresAt": "string",    "respondedAt": "string",    "completedAt": "string",    "resourceName": "string",    "sourceOrgName": "string",    "sourceOrgSlug": "string",    "targetOrgName": "string",    "targetOrgSlug": "string"  }]