Manually enable MACHINE relay for a lane

This endpoint documentation is generated directly from openapi.yaml.

Endpoint

POST /modules/self-serve/lane/relay/machine/enable

Operation

Operation ID: enableSelfServeLaneMachineRelay

Manually turns on the MACHINE relay for a self-serve lane if and only if the current allowed services include `MACHINE` (set via `/modules/self-serve/lane/services/allowed`). The relay is never automatically enabled; an explicit call to this endpoint is required.

Authentication

Security requirements:

Scheme	Scopes
BearerAuth	-

Request Body

Required: yes.

Content type: application/json

{
  "properties": {
    "duration": {
      "description": "Optional number of seconds after which the relay should automatically turn off",
      "type": "integer"
    },
    "lane_id": {
      "type": "integer"
    }
  },
  "required": [
    "lane_id"
  ],
  "type": "object"
}
        

Responses

Status	Description	Content Types
200	MACHINE relay enabled	application/json
401
403	Not allowed to enable MACHINE relay (no matching task currently shown)	application/json

Schema for response 200 (application/json):

{
  "properties": {
    "duration": {
      "nullable": true,
      "type": "integer"
    },
    "enabled": {
      "type": "boolean"
    },
    "lane_id": {
      "type": "integer"
    },
    "relay": {
      "type": "string"
    }
  },
  "type": "object"
}
        

Schema for response 403 (application/json):

{
  "$ref": "#/components/schemas/Error"
}
        

17 March 2026