README.md

Observability

Overview

Available Operations

• getObservabilityConfigurationProjects - Lists disabled Observability Plus projects
• updateObservabilityConfigurationProject - Updates a disabled Observability Plus project setting

getObservabilityConfigurationProjects

Lists the projects that are currently configured as disabled for Observability Plus on a team.

Example Usage

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.observability.getObservabilityConfigurationProjects({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { VercelCore } from "@vercel/sdk/core.js";
import { observabilityGetObservabilityConfigurationProjects } from "@vercel/sdk/funcs/observabilityGetObservabilityConfigurationProjects.js";

// Use `VercelCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const vercel = new VercelCore({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await observabilityGetObservabilityConfigurationProjects(vercel, {
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("observabilityGetObservabilityConfigurationProjects failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	models.GetObservabilityConfigurationProjectsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.GetObservabilityConfigurationProjectsResponseBody>

Errors

Error Type	Status Code	Content Type
models.SDKError	4XX, 5XX	*/*

updateObservabilityConfigurationProject

Updates whether Observability Plus is disabled for a single project.

Example Usage

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.observability.updateObservabilityConfigurationProject({
    projectIdOrName: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { VercelCore } from "@vercel/sdk/core.js";
import { observabilityUpdateObservabilityConfigurationProject } from "@vercel/sdk/funcs/observabilityUpdateObservabilityConfigurationProject.js";

// Use `VercelCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const vercel = new VercelCore({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await observabilityUpdateObservabilityConfigurationProject(vercel, {
    projectIdOrName: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("observabilityUpdateObservabilityConfigurationProject failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	models.UpdateObservabilityConfigurationProjectRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.UpdateObservabilityConfigurationProjectResponseBody>

Errors

Error Type	Status Code	Content Type
models.SDKError	4XX, 5XX	*/*