Skip to main content
PATCH
/
api
/
workers
/
{workerId}
/
deployments
/
{deploymentId}
/
params
/
{paramId}
JavaScript
import BrainbaseLabs from 'brainbase-labs';

const client = new BrainbaseLabs({
  apiKey: process.env['BRAINBASE_LABS_API_KEY'], // This is the default and can be omitted
});

const param = await client.workers.deployments.params.update('paramId', {
  workerId: 'workerId',
  deploymentId: 'deploymentId',
});

console.log(param.id);
import os
from brainbase_labs import BrainbaseLabs

client = BrainbaseLabs(
api_key=os.environ.get("BRAINBASE_LABS_API_KEY"), # This is the default and can be omitted
)
param = client.workers.deployments.params.update(
param_id="paramId",
worker_id="workerId",
deployment_id="deploymentId",
)
print(param.id)
curl --request PATCH \
--url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/{deploymentId}/params/{paramId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"value": "<string>",
"description": "<string>"
}
'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/{deploymentId}/params/{paramId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'value' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/{deploymentId}/params/{paramId}"

payload := strings.NewReader("{\n \"value\": \"<string>\",\n \"description\": \"<string>\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/{deploymentId}/params/{paramId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"value\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/{deploymentId}/params/{paramId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"value\": \"<string>\",\n \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "value": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deploymentId": "<string>",
  "description": "<string>"
}

Authorizations

x-api-key
string
header
required

API key authentication

Path Parameters

workerId
string
required
deploymentId
string
required
paramId
string
required

Body

application/json
value
string
description
string

Response

Updated parameter

id
string
required
name
string
required
value
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deploymentId
string
required
description
string | null