Update environment by id | Opik Documentation

PATCH/v1/private/environments/{id}Update environment by id

Update environment by id

Parameters

idstring · uuidpathrequired

Request body

application/json

objectEnvironmentUpdate

colorstring

maxLength 20 · minLength 0

descriptionstring

maxLength 500 · minLength 0

namestring

maxLength 150 · minLength 0 · pattern ^[A-Za-z0-9_-]+$

positioninteger · int32

Example request

{
  "color": "string",
  "description": "string",
  "name": "string",
  "position": 0
}

Responses

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

idrequiredpath parameter

curl -X PATCH 'http://localhost:5173/api/v1/private/environments/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"color":"string","description":"string","name":"string","position":0}'

const response = await fetch('http://localhost:5173/api/v1/private/environments/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"color":"string","description":"string","name":"string","position":0}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/environments/00000000-0000-0000-0000-000000000000', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"color\":\"string\",\"description\":\"string\",\"name\":\"string\",\"position\":0}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "http://localhost:5173/api/v1/private/environments/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"color":"string","description":"string","name":"string","position":0}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"color":"string","description":"string","name":"string","position":0}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "http://localhost:5173/api/v1/private/environments/00000000-0000-0000-0000-000000000000", 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/environments/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"color\":\"string\",\"description\":\"string\",\"name\":\"string\",\"position\":0}");
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/environments/00000000-0000-0000-0000-000000000000"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"color\":\"string\",\"description\":\"string\",\"name\":\"string\",\"position\":0}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/environments/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"color\":\"string\",\"description\":\"string\",\"name\":\"string\",\"position\":0}"
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.Patch, "http://localhost:5173/api/v1/private/environments/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"color\":\"string\",\"description\":\"string\",\"name\":\"string\",\"position\":0}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

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

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