55 lines
8.4 KiB
HTML
55 lines
8.4 KiB
HTML
<!DOCTYPE html SYSTEM "about:legacy-compat">
|
|
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2026-03-17T15:45:57.927642104"><title>Manually enable MACHINE relay for a lane | Copenhagen Truck Wash API</title><script type="application/json" id="virtual-toc-data">[{"id":"endpoint","level":0,"title":"Endpoint","anchor":"#endpoint"},{"id":"operation","level":0,"title":"Operation","anchor":"#operation"},{"id":"authentication","level":0,"title":"Authentication","anchor":"#authentication"},{"id":"request-body","level":0,"title":"Request Body","anchor":"#request-body"},{"id":"responses","level":0,"title":"Responses","anchor":"#responses"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.css" rel="stylesheet"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Manually enable MACHINE relay for a lane | Copenhagen Truck Wash API"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Copenhagen Truck Wash API Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/enableselfservelanemachinerelay.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Manually enable MACHINE relay for a lane | Copenhagen Truck Wash API"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
|
|
"@context": "http://schema.org",
|
|
"@type": "WebPage",
|
|
"@id": "writerside-documentation/enableselfservelanemachinerelay.html#webpage",
|
|
"url": "writerside-documentation/enableselfservelanemachinerelay.html",
|
|
"name": "Manually enable MACHINE relay for a lane | Copenhagen Truck Wash API",
|
|
"description": "",
|
|
"image": "",
|
|
"inLanguage":"en-US"
|
|
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
|
|
"@type": "WebSite",
|
|
"@id": "writerside-documentation/#website",
|
|
"url": "writerside-documentation/",
|
|
"name": "Copenhagen Truck Wash API Help"
|
|
}</script><!-- End Schema.org --></head><body data-id="enableSelfServeLaneMachineRelay" data-main-title="Manually enable MACHINE relay for a lane" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="API-Reference.topic|API Reference///Tag_Modules.topic|Modules///modules_module_self_serve.topic///modules_module_self_serve_page_1.topic"><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Copenhagen Truck Wash API Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="enableSelfServeLaneMachineRelay" id="enableSelfServeLaneMachineRelay.topic">Manually enable MACHINE relay for a lane</h1><p id="z54u2ns_2">This endpoint documentation is generated directly from <code class="code" id="z54u2ns_8">openapi.yaml</code>.</p><section class="chapter"><h2 id="endpoint" data-toc="endpoint">Endpoint</h2><div class="code-block" data-lang="http">POST /modules/self-serve/lane/relay/machine/enable</div></section><section class="chapter"><h2 id="operation" data-toc="operation">Operation</h2><p id="z54u2ns_10">Operation ID: <code class="code" id="z54u2ns_12">enableSelfServeLaneMachineRelay</code></p><p id="z54u2ns_11">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></section><section class="chapter"><h2 id="authentication" data-toc="authentication">Authentication</h2><p id="z54u2ns_13">Security requirements:</p><div class="table-wrapper"><table class="wide" id="z54u2ns_14"><thead><tr class="ijRowHead" id="z54u2ns_15"><th id="z54u2ns_17"><p>Scheme</p></th><th id="z54u2ns_18"><p>Scopes</p></th></tr></thead><tbody><tr id="z54u2ns_16"><td id="z54u2ns_19"><p>BearerAuth</p></td><td id="z54u2ns_20"><p>-</p></td></tr></tbody></table></div></section><section class="chapter"><h2 id="request-body" data-toc="request-body">Request Body</h2><p id="z54u2ns_21">Required: yes.</p><p id="z54u2ns_22">Content type: <code class="code" id="z54u2ns_24">application/json</code></p><div class="code-block" data-lang="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"
|
|
}
|
|
</div></section><section class="chapter"><h2 id="responses" data-toc="responses">Responses</h2><div class="table-wrapper"><table class="wide" id="z54u2ns_25"><thead><tr class="ijRowHead" id="z54u2ns_30"><th id="z54u2ns_34"><p>Status</p></th><th id="z54u2ns_35"><p>Description</p></th><th id="z54u2ns_36"><p>Content Types</p></th></tr></thead><tbody><tr id="z54u2ns_31"><td id="z54u2ns_37"><p>200</p></td><td id="z54u2ns_38"><p>MACHINE relay enabled</p></td><td id="z54u2ns_39"><p>application/json</p></td></tr><tr id="z54u2ns_32"><td id="z54u2ns_40"><p>401</p></td><td id="z54u2ns_41"></td><td id="z54u2ns_42"></td></tr><tr id="z54u2ns_33"><td id="z54u2ns_43"><p>403</p></td><td id="z54u2ns_44"><p>Not allowed to enable MACHINE relay (no matching task currently shown)</p></td><td id="z54u2ns_45"><p>application/json</p></td></tr></tbody></table></div><p id="z54u2ns_26">Schema for response <code class="code" id="z54u2ns_46">200</code> (<code class="code" id="z54u2ns_47">application/json</code>):</p><div class="code-block" data-lang="json">
|
|
{
|
|
"properties": {
|
|
"duration": {
|
|
"nullable": true,
|
|
"type": "integer"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"lane_id": {
|
|
"type": "integer"
|
|
},
|
|
"relay": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
</div><p id="z54u2ns_28">Schema for response <code class="code" id="z54u2ns_48">403</code> (<code class="code" id="z54u2ns_49">application/json</code>):</p><div class="code-block" data-lang="json">
|
|
{
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
</div></section><div class="last-modified">17 March 2026</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="getselfservelanestatus.html" class="navigation-links__prev">Get self-serve lane status</a><a href="sendselfservelanecommand.html" class="navigation-links__next">Send self-serve lane command</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.js"></script></body></html> |