Activate a pairing session | Opik Documentation

POST/v1/private/pairing/sessions/{sessionId}/activateActivate a pairing session

Verify the activation HMAC and flip the runner row to CONNECTED

Parameters

sessionIdstring · uuidpathrequired

Request body

application/json

objectActivateRequest

hmacstringrequired

maxLength 44 · minLength 43

runner_namestringrequired

maxLength 128 · minLength 0

Example request

{
  "hmac": "string",
  "runner_name": "string"
}

Responses

Headers

Location

URI of the runner

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

sessionIdrequiredpath parameter

curl -X POST 'http://localhost:5173/api/v1/private/pairing/sessions/00000000-0000-0000-0000-000000000000/activate' \
  -H 'Content-Type: application/json' \
  -d '{"hmac":"string","runner_name":"string"}'

const response = await fetch('http://localhost:5173/api/v1/private/pairing/sessions/00000000-0000-0000-0000-000000000000/activate', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"hmac":"string","runner_name":"string"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/pairing/sessions/00000000-0000-0000-0000-000000000000/activate', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"hmac\":\"string\",\"runner_name\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/pairing/sessions/00000000-0000-0000-0000-000000000000/activate",
    headers={"Content-Type": "application/json"},
    data='{"hmac":"string","runner_name":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"hmac":"string","runner_name":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/pairing/sessions/00000000-0000-0000-0000-000000000000/activate", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/pairing/sessions/00000000-0000-0000-0000-000000000000/activate");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"hmac\":\"string\",\"runner_name\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/pairing/sessions/00000000-0000-0000-0000-000000000000/activate"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"hmac\":\"string\",\"runner_name\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/pairing/sessions/00000000-0000-0000-0000-000000000000/activate")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"hmac\":\"string\",\"runner_name\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/pairing/sessions/00000000-0000-0000-0000-000000000000/activate");
request.Content = new StringContent("{\"hmac\":\"string\",\"runner_name\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 201)

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}