Patch Listener

Patch a listener by ID.

PATCH /v2/listeners/{listener_id}

Patch Listener

cURL

curl --request PATCH \
  --url https://api.example.com/v2/listeners/{listener_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "<string>",
  "compute_config": {
    "k8s_namespaces": [
      "<string>"
    ]
  }
}
'

import requests

url = "https://api.example.com/v2/listeners/{listener_id}"

payload = {
    "version": "<string>",
    "compute_config": { "k8s_namespaces": ["<string>"] }
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({version: '<string>', compute_config: {k8s_namespaces: ['<string>']}})
};

fetch('https://api.example.com/v2/listeners/{listener_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/listeners/{listener_id}",
  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([
    'version' => '<string>',
    'compute_config' => [
        'k8s_namespaces' => [
                '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://api.example.com/v2/listeners/{listener_id}"

	payload := strings.NewReader("{\n  \"version\": \"<string>\",\n  \"compute_config\": {\n    \"k8s_namespaces\": [\n      \"<string>\"\n    ]\n  }\n}")

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

	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://api.example.com/v2/listeners/{listener_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": \"<string>\",\n  \"compute_config\": {\n    \"k8s_namespaces\": [\n      \"<string>\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/listeners/{listener_id}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"version\": \"<string>\",\n  \"compute_config\": {\n    \"k8s_namespaces\": [\n      \"<string>\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "compute_type": "<string>",
  "compute_id": "<string>",
  "compute_config": {
    "k8s_namespaces": [
      "<string>"
    ]
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "version": "<string>"
}

{
  "detail": "Listeners cannot be created for LangSmith workspace ID '{workspace_id}'. Creating listeners is only allowed for LangSmith organizations with self-hosted enterprise plans."
}

{
  "detail": "Listener ID {listener_id} not found."
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

listener_id · string<uuid> · required

Body

application/json

Requst body for patching a listener.

version · string | null

The version of the listener.

compute_config · ListenerComputeConfig · object | null

Fields for a listener that are specific to compute_type.

All fields are nullable, but are validated based on compute_type.

Show child attributes

Response

200

application/json

Successful Response

Listener resource.

compute_type · string · required

The compute type of the listener.

This cannot be changed (PUT) once the listener is created.

Allowed value: "k8s"

compute_id · string · required

User assigned unique ID of the compute infrastructure for the listener.

For example, if compute_type is k8s, then the user may set this field to the Kubernetes cluster name. This cannot be changed (PUT) once the listener is created.

compute_config · ListenerComputeConfig · object · required

Fields for a listener that are specific to compute_type.

All fields are nullable, but are validated based on compute_type.

Show child attributes

id · string<uuid> · required

System assigned ID of the listener.

This is a read-only field.

created_at · string<date-time> · required

The creation time of the listener.

This is a read-only field.

updated_at · string<date-time> · required

The last update time of the listener.

This is a read-only field.

version · string | null

The version of the listener.