🧩 Scale out Relay

Promote a node to relay

post/scaleoutrelay/promote/{nodeId}

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/scaleoutrelay/promote/:nodeId/post.ts
A function with typed inputs. Its response is checked against the schema.

nodeIdstring uuid (or "root") required

Example:9a1773c9-0889-40b6-be89-f6504443ac1b

Id of the target node

Promote response

action'promoteToRelay' required

The id of the action

result'success' | 'error' required

Result of the request

datastring required

Success or error message

{
  "data": "17dadf50-6056-4c8b-a935-6b97d14b89a7"
}

No recorded changes to this operation across all 7 revisions of this API.