api/documentation/topics/generated/enableSelfServeLaneMachineRelay.topic

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
        SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
       title="Manually enable MACHINE relay for a lane" id="enableSelfServeLaneMachineRelay">

    <!-- AUTO-GENERATED, DO NOT EDIT -->
    <p>This endpoint documentation is generated directly from <code>openapi.yaml</code>.</p>
    <chapter title="Endpoint" id="endpoint">
        <code-block lang="http">POST /modules/self-serve/lane/relay/machine/enable</code-block>
    </chapter>
    <chapter title="Operation" id="operation">
        <p>Operation ID: <code>enableSelfServeLaneMachineRelay</code></p>
        <p>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.
</p>
    </chapter>
    <chapter title="Authentication" id="authentication">
        <p>Security requirements:</p>
        <table>
            <tr><td>Scheme</td><td>Scopes</td></tr>
            <tr><td>BearerAuth</td><td>-</td></tr>
        </table>
    </chapter>
    <chapter title="Request Body" id="request-body">
        <p>Required: yes.</p>
        <p>Content type: <code>application/json</code></p>
        <code-block lang="json">
{
  &quot;properties&quot;: {
    &quot;duration&quot;: {
      &quot;description&quot;: &quot;Optional number of seconds after which the relay should automatically turn off&quot;,
      &quot;type&quot;: &quot;integer&quot;
    },
    &quot;lane_id&quot;: {
      &quot;type&quot;: &quot;integer&quot;
    }
  },
  &quot;required&quot;: [
    &quot;lane_id&quot;
  ],
  &quot;type&quot;: &quot;object&quot;
}
        </code-block>
    </chapter>
    <chapter title="Responses" id="responses">
        <table>
            <tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
            <tr><td>200</td><td>MACHINE relay enabled</td><td>application/json</td></tr>
            <tr><td>401</td><td></td><td></td></tr>
            <tr><td>403</td><td>Not allowed to enable MACHINE relay (no matching task currently shown)</td><td>application/json</td></tr>
        </table>
        <p>Schema for response <code>200</code> (<code>application/json</code>):</p>
        <code-block lang="json">
{
  &quot;properties&quot;: {
    &quot;duration&quot;: {
      &quot;nullable&quot;: true,
      &quot;type&quot;: &quot;integer&quot;
    },
    &quot;enabled&quot;: {
      &quot;type&quot;: &quot;boolean&quot;
    },
    &quot;lane_id&quot;: {
      &quot;type&quot;: &quot;integer&quot;
    },
    &quot;relay&quot;: {
      &quot;type&quot;: &quot;string&quot;
    }
  },
  &quot;type&quot;: &quot;object&quot;
}
        </code-block>
        <p>Schema for response <code>403</code> (<code>application/json</code>):</p>
        <code-block lang="json">
{
  &quot;$ref&quot;: &quot;#/components/schemas/Error&quot;
}
        </code-block>
    </chapter>
</topic>