Get a Global Config item

APIs & SDKs

GEThttps://api.vercel.com/v1/global-config/{edgeConfigId}/item/{edgeConfigItemKey}

Returns a specific Global Config Item.

Request

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

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

async function run() {
  const result = await vercel.globalConfig.getEdgeConfigItem({
    edgeConfigId: "<id>",
    edgeConfigItemKey: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

{
  "createdAt": "123",
  "description": "string",
  "edgeConfigId": "example_id",
  "key": "string",
  "updatedAt": "123",
  "value": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

edgeConfigIdstringRequired

edgeConfigItemKeystringRequired

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200The Global Config.

createdAtnumberRequired

descriptionstringOptional

edgeConfigIdstringRequired

keystringRequired

updatedAtnumberRequired

valueobjectRequired5 variants

204The Global Config item does not exist.

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

Request

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

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

async function run() {
  const result = await vercel.globalConfig.getEdgeConfigItem({
    edgeConfigId: "<id>",
    edgeConfigItemKey: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

{
  "createdAt": "123",
  "description": "string",
  "edgeConfigId": "example_id",
  "key": "string",
  "updatedAt": "123",
  "value": "string"
}

OpenAPI Specification