Create a trace session token for a deployment

APIs & SDKs

POSThttps://api.vercel.com/v1/projects/traces/session

Mints a short-lived HS256 JWT scoped to a deployment hostname. The Vercel CLI presents this JWT to the Vercel proxy on requests it wants traced.

https://api.vercel.com/v1/projects/traces/session

const response = await fetch('https://api.vercel.com/v1/projects/traces/session?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "projectId": "example_id",
    "hostname": "Example Name"
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "token": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

projectIdstringRequired

The project ID the deployment belongs to.

hostnamestringRequired

The deployment hostname to scope the trace session to.

Response

200Success

tokenstringRequired

Errors

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

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

422Error

Cross-link map: Create a trace session token for a deployment (/docs/rest-api/projects/create-a-trace-session-token-for-a-deployment)

From the Vercel docs graph (built 2026-10-14T10:24:21.026Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Create an Auth Token — POST /v3/user/tokens — Creates and returns a new authentication token for the currently authenticated User. The \`bearer
Get a project trace by request ID — GET /v1/projects/traces — Returns the OTEL trace for a given Vercel CLI request.
Generate a project OIDC token — POST /v1/projects/{idOrName}/token — Generates an OIDC token for the project and returns it.
Get deployment events — GET /v3/deployments/{idOrUrl}/events — Get the build logs of a deployment by deployment ID and build ID. It can work as
Get logs for a deployment — GET /v1/projects/{projectId}/deployments/{deploymentId}/runtime-logs — Returns a stream of logs for a given deployment.

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v1/projects/traces/session

const response = await fetch('https://api.vercel.com/v1/projects/traces/session?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "projectId": "example_id",
    "hostname": "Example Name"
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "token": "string"
}

OpenAPI Specification