APIs / Vercel
Breaking changes, deprecations and new fields in the Vercel API, as they ship.
Vercel1 breakingNo error is raised. The value is ignored and your results change silently, which is the hardest class of break to notice.
await client.post("/v2/sandboxes/sessions/{sessionId}/cmd", {
// cmdId is now ignored, not rejected
cmdId: value,
});Vercel1 breaking1 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "connect-cancel-mcp-event-subscription", "connect-create-mcp-event-subscription", "organization-name-update"
switch (response.name) {
// existing branches …
// no branch for "connect-cancel-mcp-event-subscription"
// no branch for "connect-create-mcp-event-subscription"
// no branch for "organization-name-update"
default:
throw new Error("unexpected name");
}No action needed unless it is required.
Vercel2 breaking4 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "read-write:access-group"
switch (response.payload.permissions[0]) {
// existing branches …
// no branch for "read-write:access-group"
default:
throw new Error("unexpected permissions");
}Producer-side tools call this non-breaking. For a consumer it is a null dereference on an unknown future date.
// response.payload.author may now be absent or null const author = response.payload.author ?? fallback;
No action needed.
No action needed.
No action needed.
No action needed.
Vercel3 breaking2 behavioral9 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "26.x"
switch (response.nodeVersion) {
// existing branches …
// no branch for "26.x"
default:
throw new Error("unexpected nodeVersion");
}Reads of this field return undefined, and the failure surfaces wherever that value is used rather than at the call.
// response.result is now undefined const result = response.result;
// response.pagination is now undefined const pagination = response.pagination;
An unhandled branch in your error handling.
Dead branch, or an undocumented response you still receive.
Vercel4 additiveVercel1 breaking2 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "firewall-conditional-bypass-created", "firewall-conditional-bypass-deleted"
switch (response.name) {
// existing branches …
// no branch for "firewall-conditional-bypass-created"
// no branch for "firewall-conditional-bypass-deleted"
default:
throw new Error("unexpected name");
}No action needed.
No action needed unless you validate responses against a closed schema.
Vercel2 breaking2 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "response_code"
switch (response.active.conditions[0].conditionGroup[0].conditions[0].type) {
// existing branches …
// no branch for "response_code"
default:
throw new Error("unexpected type");
}Producer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "read-write:project-members", "read:audit-log", "read:project-members"
switch (response.payload.nextPermissions[0]) {
// existing branches …
// no branch for "read-write:project-members"
// no branch for "read:audit-log"
// no branch for "read:project-members"
default:
throw new Error("unexpected nextPermissions");
}Vercel1 behavioralAn unhandled branch in your error handling.
Vercel1 breakingProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "read-write:ai-gateway-budgets", "read:ai-gateway-budgets"
switch (response.payload.permissions[0]) {
// existing branches …
// no branch for "read-write:ai-gateway-budgets"
// no branch for "read:ai-gateway-budgets"
default:
throw new Error("unexpected permissions");
}Vercel1 breaking1 behavioral9 additiveProducer-side tools call this non-breaking. For a consumer it is a null dereference on an unknown future date.
// response.services[0].builder.config.daemon.replicas may now be absent or null const replicas = response.services[0].builder.config.daemon.replicas ?? fallback;
An unhandled branch in your error handling.
No action needed.
No action needed.
No action needed.
Vercel2 additiveVercel1 breakingUsually ignored rather than rejected, so the call succeeds and does something subtly different.
await client.post("/v9/projects/{idOrName}", {
// protectionMode is now ignored, not rejected
protectionMode: value,
});Vercel3 behavioral6 additiveDead branch, or an undocumented response you still receive.
Vercel1 behavioral1 additiveAn unhandled branch in your error handling.
No action needed.
Vercel1 breaking3 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "admin-saml-sp-signing-key-created", "admin-saml-sp-signing-key-updated"
switch (response.name) {
// existing branches …
// no branch for "admin-saml-sp-signing-key-created"
// no branch for "admin-saml-sp-signing-key-updated"
default:
throw new Error("unexpected name");
}No action needed.
No action needed.
No action needed.
Vercel2 additiveVercel1 breakingProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "organization-dsync-sync-start"
switch (response.name) {
// existing branches …
// no branch for "organization-dsync-sync-start"
default:
throw new Error("unexpected name");
}Vercel2 breaking1 behavioral5 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "admin-saml-idp-material-deleted", "admin-saml-idp-material-set", "vercel-ci-repository-settings-updated"
switch (response.name) {
// existing branches …
// no branch for "admin-saml-idp-material-deleted"
// no branch for "admin-saml-idp-material-set"
// no branch for "vercel-ci-repository-settings-updated"
default:
throw new Error("unexpected name");
}Producer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "stripe-api-key"
switch (response.type) {
// existing branches …
// no branch for "stripe-api-key"
default:
throw new Error("unexpected type");
}An unhandled branch in your error handling.
No action needed.
No action needed.
No action needed.
No action needed.
No action needed unless it is required.
Vercel1 breaking1 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "sandbox-drive-snapshot-created", "sandbox-drive-snapshot-deleted"
switch (response.name) {
// existing branches …
// no branch for "sandbox-drive-snapshot-created"
// no branch for "sandbox-drive-snapshot-deleted"
default:
throw new Error("unexpected name");
}No action needed unless you validate responses against a closed schema.
Vercel1 additiveNo action needed.
Vercel1 breaking24 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "organization-dsync-delete"
switch (response.name) {
// existing branches …
// no branch for "organization-dsync-delete"
default:
throw new Error("unexpected name");
}No action needed.
Vercel6 additiveVercel1 breaking1 behavioral7 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "messageboard-private-space-updated", "messageboard-space-updated", "v0-migration-subscription-completed"
switch (response.name) {
// existing branches …
// no branch for "messageboard-private-space-updated"
// no branch for "messageboard-space-updated"
// no branch for "v0-migration-subscription-completed"
default:
throw new Error("unexpected name");
}Dead branch, or an undocumented response you still receive.
No action needed.
Vercel1 breaking4 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "messageboard-schema-registered", "messageboard-visibility-updated"
switch (response.name) {
// existing branches …
// no branch for "messageboard-schema-registered"
// no branch for "messageboard-visibility-updated"
default:
throw new Error("unexpected name");
}No action needed.
Vercel1 breaking5 additiveReads of this field return undefined, and the failure surfaces wherever that value is used rather than at the call.
// response.projects[0].rollingRelease.gate.checks[0].minSampleSize is now undefined const minSampleSize = response.projects[0].rollingRelease.gate.checks[0].minSampleSize;
No action needed.
Vercel1 breakingProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "project-avatar-dark-mode-update"
switch (response.name) {
// existing branches …
// no branch for "project-avatar-dark-mode-update"
default:
throw new Error("unexpected name");
}Vercel2 additiveVercel2 breaking1 behavioral16 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "v0-migration-payment-confirmed"
switch (response.name) {
// existing branches …
// no branch for "v0-migration-payment-confirmed"
default:
throw new Error("unexpected name");
}Usually ignored rather than rejected, so the call succeeds and does something subtly different.
await client.post("/…", {
// triggerData is now ignored, not rejected
triggerData: value,
});An unhandled branch in your error handling.
No action needed.
Vercel1 breaking2 additiveReads of this field return undefined, and the failure surfaces wherever that value is used rather than at the call.
// response.projects[0].abuse is now undefined const abuse = response.projects[0].abuse;
Vercel2 breaking2 behavioral1 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
switch (response.deploymentStorageRollout.meterReason) {
// existing branches …
// no branch for "retention_opt_out"
default:
throw new Error("unexpected meterReason");
}Producer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
switch (response.deploymentStorageRollout.cohort) {
// existing branches …
// no branch for "already_metered"
// no branch for "extreme"
// no branch for "medium_plus"
// no branch for "metered_opt_in"
default:
throw new Error("unexpected cohort");
}An unhandled branch in your error handling.
An unhandled branch in your error handling.
No action needed unless you validate responses against a closed schema.
Vercel1 breaking5 additiveReads of this field return undefined, and the failure surfaces wherever that value is used rather than at the call.
// response.schema is now undefined const schema = response.schema;
Vercel1 breakingReads of this field return undefined, and the failure surfaces wherever that value is used rather than at the call.
// response.payload.newOwner.email is now undefined const email = response.payload.newOwner.email;
Vercel3 breaking19 additiveProducer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "read-write:project-trusted-sources", "read:project-trusted-sources"
switch (response.payload.before.permissions[0]) {
// existing branches …
// no branch for "read-write:project-trusted-sources"
// no branch for "read:project-trusted-sources"
default:
throw new Error("unexpected permissions");
}Reads of this field return undefined, and the failure surfaces wherever that value is used rather than at the call.
// response.payload.next.default is now undefined const default = response.payload.next.default;
// response.payload.next.roles is now undefined const roles = response.payload.next.roles;
No action needed.
No action needed.
Vercel3 breaking1 behavioral4 additiveReads of this field return undefined, and the failure surfaces wherever that value is used rather than at the call.
// response.createdAt is now undefined const createdAt = response.createdAt;
Producer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.
can now return "flags-connection-created", "flags-connection-deleted"
switch (response.name) {
// existing branches …
// no branch for "flags-connection-created"
// no branch for "flags-connection-deleted"
default:
throw new Error("unexpected name");
}Parse failure, or silent coercion depending on your client.
// payload // was: object // now: array
An unhandled branch in your error handling.
Vercel1 behavioralDead branch, or an undocumented response you still receive.
Vercel2 breaking6 additiveReads of this field return undefined, and the failure surfaces wherever that value is used rather than at the call.
// response.internalContentHint is now undefined const internalContentHint = response.internalContentHint;
// response.legacyValue is now undefined const legacyValue = response.legacyValue;
No action needed.
No action needed.
No action needed.
No action needed.
No action needed.
No action needed unless you validate responses against a closed schema.
Vercel1 additiveNo action needed unless you validate responses against a closed schema.