Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Bring your own key. This API needs your own Vercel API key - get one from the provider, add it once below, and the proxy injects it on every call. Your OmniStream plan covers the unified SDK, key storage, and proxy - the provider's own rate limits still apply to your key.
This is a community listing. If you own this API, you can request ownership.
npm install omnistream-sdkimport { OmniClient } from "omnistream-sdk";
const omni = new OmniClient({ token: process.env.OMNI_KEY! });
// One key reaches every API on the marketplace.
const data = await omni.call("vercel/getEdgeConfigs");One install, one key - the same client calls every API on the marketplace.
The name of the domain for which we would like to check the status.
The Team identifier or slug to perform the request on behalf of.
Get Edge Configs
Create an Edge Config
Get an Edge Config
Update an Edge Config
Delete an Edge Config
Get an Edge Config item
/**
* VercelAPI - generated by OmniStream from Vercel API's OpenAPI spec.
* One typed method per endpoint. A single Omni key reaches the API.
*/
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/vercel";
export class VercelAPIError extends Error {
status: number;
code?: string;
constructor(status: number, code: string | undefined, message?: string) {
super(message || `VercelAPI error ${status}`);
this.name = "VercelAPIError";
this.status = status;
this.code = code;
}
}
export interface VercelAPIOptions {
baseUrl?: string;
fetch?: typeof fetch;
timeoutMs?: number;
}
export class VercelAPI {
/** @param token Your OmniStream key (one key for every API). */
constructor(private token: string, private opts: VercelAPIOptions = {}) {
if (!token) throw new Error("VercelAPI: token is required");
}
rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;
private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
const f = this.opts.fetch ?? globalThis.fetch;
const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
const headers: Record<string, string> = { "x-omni-key": this.token };
if (body !== undefined) headers["content-type"] = "application/json";
const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
this.rateLimit = {
remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
};
const data = await res.json().catch(() => ({}));
if (!res.ok) throw new VercelAPIError(res.status, data?.error?.code, data?.error?.message);
return data.data ?? data;
}
/** Get Edge Configs */
getEdgeConfigs(params: { "teamId"?: string }): Promise<any> {
return this._request("GET", "/edge-config", { params });
}
/** Create an Edge Config */
createEdgeConfig(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("POST", "/edge-config", { body, params });
}
/** Get an Edge Config */
getEdgeConfig(params: { "edgeConfigId": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/edge-config/{edgeConfigId}", { params });
}
/** Update an Edge Config */
updateEdgeConfig(body: unknown, params: { "edgeConfigId": string; "teamId"?: string }): Promise<any> {
return this._request("PUT", "/edge-config/{edgeConfigId}", { body, params });
}
/** Delete an Edge Config */
deleteEdgeConfig(params: { "edgeConfigId": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/edge-config/{edgeConfigId}", { params });
}
/** Get an Edge Config item */
getEdgeConfigItem(params: { "edgeConfigId": string; "edgeConfigItemKey": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/edge-config/{edgeConfigId}/item/{edgeConfigItemKey}", { params });
}
/** Get Edge Config items */
getEdgeConfigItems(params: { "edgeConfigId": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/edge-config/{edgeConfigId}/items", { params });
}
/** Update Edge Config items in batch */
patchtEdgeConfigItems(body: unknown, params: { "edgeConfigId": string; "teamId"?: string }): Promise<any> {
return this._request("PATCH", "/edge-config/{edgeConfigId}/items", { body, params });
}
/** Create an Edge Config token */
createEdgeConfigToken(body: unknown, params: { "edgeConfigId": string; "teamId"?: string }): Promise<any> {
return this._request("POST", "/edge-config/{edgeConfigId}/token", { body, params });
}
/** Get Edge Config token meta data */
getEdgeConfigToken(params: { "edgeConfigId": string; "token": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/edge-config/{edgeConfigId}/token/{token}", { params });
}
/** Get all tokens of an Edge Config */
getEdgeConfigTokens(params: { "edgeConfigId": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/edge-config/{edgeConfigId}/tokens", { params });
}
/** Delete one or more Edge Config tokens */
deleteEdgeConfigTokens(params: { "edgeConfigId": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/edge-config/{edgeConfigId}/tokens", { params });
}
/** Login with email */
emailLogin(body: unknown): Promise<any> {
return this._request("POST", "/registration", { body });
}
/** Verify a login request to get an authentication token */
verifyToken(params: { "token": string; "email"?: string; "tokenName"?: string; "ssoUserId"?: string }): Promise<any> {
return this._request("GET", "/registration/verify", { params });
}
/** Retrieve a list of all checks */
getAllChecks(params: { "deploymentId": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/deployments/{deploymentId}/checks", { params });
}
/** Creates a new Check */
createCheck(body: unknown, params: { "deploymentId": string; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v1/deployments/{deploymentId}/checks", { body, params });
}
/** Get a single check */
getCheck(params: { "deploymentId": string; "checkId": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/deployments/{deploymentId}/checks/{checkId}", { params });
}
/** Update a check */
updateCheck(body: unknown, params: { "deploymentId": string; "checkId": string; "teamId"?: string }): Promise<any> {
return this._request("PATCH", "/v1/deployments/{deploymentId}/checks/{checkId}", { body, params });
}
/** Rerequest a check */
rerequestCheck(params: { "deploymentId": string; "checkId": string; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v1/deployments/{deploymentId}/checks/{checkId}/rerequest", { params });
}
/** Update an existing DNS record */
updateRecord(body: unknown, params: { "recordId": string; "teamId"?: string }): Promise<any> {
return this._request("PATCH", "/v1/domains/records/{recordId}", { body, params });
}
/** Retrieve an integration configuration */
getConfiguration(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/integrations/configuration/{id}", { params });
}
/** Delete an integration configuration */
deleteConfiguration(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v1/integrations/configuration/{id}", { params });
}
/** Get configurations for the authenticated user or team */
getConfigurations(params: { "view": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/integrations/configurations", { params });
}
/** List git namespaces by provider */
gitNamespaces(params: { "provider"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/integrations/git-namespaces", { params });
}
/** Deletes the Integration log drain with the provided `id` */
deleteIntegrationLogDrain(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v1/integrations/log-drains/{id}", { params });
}
/** List git repositories linked to namespace by provider */
getv1IntegrationsSearchRepo(params: { "query"?: string; "namespaceId"?: string; "provider"?: string; "installationId"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/integrations/search-repo", { params });
}
/** Retrieves a list of Configurable Log Drains */
getConfigurableLogDrains(params: { "projectId"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/log-drains", { params });
}
/** Creates a Configurable Log Drain */
createConfigurableLogDrain(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("POST", "/v1/log-drains", { body, params });
}
/** Retrieves a Configurable Log Drain */
getConfigurableLogDrain(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/log-drains/{id}", { params });
}
/** Deletes a Configurable Log Drain */
deleteConfigurableLogDrain(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v1/log-drains/{id}", { params });
}
/** Retrieve the decrypted value of an environment variable of a project by id */
getProjectEnv(params: { "idOrName": string; "id": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/projects/{idOrName}/env/{id}", { params });
}
/** Create a Team */
createTeam(body: unknown): Promise<any> {
return this._request("POST", "/v1/teams", { body });
}
/** Delete a Team */
deleteTeam(params: { "teamId": string }): Promise<any> {
return this._request("DELETE", "/v1/teams/{teamId}", { params });
}
/** Delete a Team invite code */
deleteTeamInviteCode(params: { "inviteId": string; "teamId": string }): Promise<any> {
return this._request("DELETE", "/v1/teams/{teamId}/invites/{inviteId}", { params });
}
/** Invite a user */
inviteUserToTeam(body: unknown, params: { "teamId": string }): Promise<any> {
return this._request("POST", "/v1/teams/{teamId}/members", { body, params });
}
/** Join a team */
joinTeam(body: unknown, params: { "teamId": string }): Promise<any> {
return this._request("POST", "/v1/teams/{teamId}/members/teams/join", { body, params });
}
/** Update a Team Member */
updateTeamMember(body: unknown, params: { "uid": string; "teamId": string }): Promise<any> {
return this._request("PATCH", "/v1/teams/{teamId}/members/{uid}", { body, params });
}
/** Remove a Team Member */
removeTeamMember(params: { "uid": string; "teamId": string }): Promise<any> {
return this._request("DELETE", "/v1/teams/{teamId}/members/{uid}", { params });
}
/** Request access to a team */
requestAccessToTeam(body: unknown, params: { "teamId": string }): Promise<any> {
return this._request("POST", "/v1/teams/{teamId}/request", { body, params });
}
/** Get access request status */
getTeamAccessRequest(params: { "userId": string; "teamId": string }): Promise<any> {
return this._request("GET", "/v1/teams/{teamId}/request/{userId}", { params });
}
/** Delete User Account */
requestDelete(): Promise<any> {
return this._request("DELETE", "/v1/user", {});
}
/** Get a list of webhooks */
getWebhooks(params: { "projectId"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/webhooks", { params });
}
/** Creates a webhook */
createWebhook(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("POST", "/v1/webhooks", { body, params });
}
/** Get a webhook */
getWebhook(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v1/webhooks/{id}", { params });
}
/** Deletes a webhook */
deleteWebhook(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v1/webhooks/{id}", { params });
}
/** Create one or more environment variables */
createProjectEnv(body: unknown, params: { "idOrName": string; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v10/projects/{idOrName}/env", { body, params });
}
/** List Deployment Builds */
listDeploymentBuilds(params: { "deploymentId": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v11/deployments/{deploymentId}/builds", { params });
}
/** Cancel a deployment */
cancelDeployment(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("PATCH", "/v12/deployments/{id}/cancel", { params });
}
/** Create a new deployment */
createDeployment(body: unknown, params: { "forceNew"?: string; "skipAutoDetectionConfirmation"?: string; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v13/deployments", { body, params });
}
/** Get a deployment by ID or URL */
getDeployment(params: { "idOrUrl": string; "withGitRepoInfo"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v13/deployments/{idOrUrl}", { params });
}
/** Delete a Deployment */
deleteDeployment(params: { "id": string; "url"?: string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v13/deployments/{id}", { params });
}
/** Delete an Alias */
deleteAlias(params: { "aliasId": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v2/aliases/{aliasId}", { params });
}
/** Get deployment events */
getDeploymentEvents(params: { "idOrUrl": string; "direction"?: string; "follow"?: number; "limit"?: number; "name"?: string; "since"?: number; "until"?: number; "statusCode"?: string; "delimiter"?: number; "builds"?: number; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v2/deployments/{idOrUrl}/events", { params });
}
/** List Deployment Aliases */
listDeploymentAliases(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v2/deployments/{id}/aliases", { params });
}
/** Assign an Alias */
assignAlias(body: unknown, params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v2/deployments/{id}/aliases", { body, params });
}
/** Create a DNS record */
createRecord(body: unknown, params: { "domain": string; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v2/domains/{domain}/records", { body, params });
}
/** Delete a DNS record */
removeRecord(params: { "domain": string; "recordId": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v2/domains/{domain}/records/{recordId}", { params });
}
/** Upload Deployment Files */
uploadFile(params: { "Content-Length"?: number; "x-vercel-digest"?: string; "x-now-digest"?: string; "x-now-size"?: number; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v2/files", { params });
}
/** Retrieves a list of Integration log drains */
getIntegrationLogDrains(params: { "teamId"?: string }): Promise<any> {
return this._request("GET", "/v2/integrations/log-drains", { params });
}
/** Creates a new Integration Log Drain */
createLogDrain(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("POST", "/v2/integrations/log-drains", { body, params });
}
/** Delete a secret */
deleteSecret(params: { "idOrName": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v2/secrets/{idOrName}", { params });
}
/** Create a new secret */
createSecret(body: unknown, params: { "name": string; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v2/secrets/{name}", { body, params });
}
/** Change secret name */
renameSecret(body: unknown, params: { "name": string; "teamId"?: string }): Promise<any> {
return this._request("PATCH", "/v2/secrets/{name}", { body, params });
}
/** List all teams */
getTeams(params: { "limit"?: number; "since"?: number; "until"?: number }): Promise<any> {
return this._request("GET", "/v2/teams", { params });
}
/** Get a Team */
getTeam(params: { "teamId": string; "slug"?: string }): Promise<any> {
return this._request("GET", "/v2/teams/{teamId}", { params });
}
/** Update a Team */
patchTeam(body: unknown, params: { "teamId": string }): Promise<any> {
return this._request("PATCH", "/v2/teams/{teamId}", { body, params });
}
/** List team members */
getTeamMembers(params: { "teamId": string; "limit"?: number; "since"?: number; "until"?: number; "search"?: string; "role"?: string; "excludeProject"?: string }): Promise<any> {
return this._request("GET", "/v2/teams/{teamId}/members", { params });
}
/** Get the User */
getAuthUser(): Promise<any> {
return this._request("GET", "/v2/user", {});
}
/** List User Events */
listUserEvents(params: { "limit"?: number; "since"?: string; "until"?: string; "types"?: string; "userId"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v3/events", { params });
}
/** List secrets */
getSecrets(params: { "id"?: string; "projectId"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v3/secrets", { params });
}
/** Get a single secret */
getSecret(params: { "idOrName": string; "decrypt"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v3/secrets/{idOrName}", { params });
}
/** Create an Auth Token */
createAuthToken(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("POST", "/v3/user/tokens", { body, params });
}
/** Delete an authentication token */
deleteAuthToken(params: { "tokenId": string }): Promise<any> {
return this._request("DELETE", "/v3/user/tokens/{tokenId}", { params });
}
/** List aliases */
listAliases(params: { "domain"?: string; "from"?: number; "limit"?: number; "projectId"?: string; "since"?: number; "until"?: number; "rollbackDeploymentId"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v4/aliases", { params });
}
/** Get an Alias */
getAlias(params: { "idOrAlias": string; "from"?: number; "projectId"?: string; "since"?: number; "until"?: number; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v4/aliases/{idOrAlias}", { params });
}
/** Register or transfer-in a new Domain */
createOrTransferDomain(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("POST", "/v4/domains", { body, params });
}
/** Purchase a domain */
buyDomain(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("POST", "/v4/domains/buy", { body, params });
}
/** Check the price for a domain */
checkDomainPrice(params: { "name": string; "type"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v4/domains/price", { params });
}
/** Check a Domain Availability */
checkDomainStatus(params: { "name": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v4/domains/status", { params });
}
/** List existing DNS records */
getRecords(params: { "domain": string; "limit"?: string; "since"?: string; "until"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v4/domains/{domain}/records", { params });
}
/** List all the domains */
getDomains(params: { "limit"?: number; "since"?: number; "until"?: number; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v5/domains", { params });
}
/** Get Information for a Single Domain */
getDomain(params: { "domain": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v5/domains/{domain}", { params });
}
/** List Auth Tokens */
listAuthTokens(): Promise<any> {
return this._request("GET", "/v5/user/tokens", {});
}
/** Get Auth Token Metadata */
getAuthToken(params: { "tokenId": string }): Promise<any> {
return this._request("GET", "/v5/user/tokens/{tokenId}", { params });
}
/** List deployments */
getDeployments(params: { "app"?: string; "from"?: number; "limit"?: number; "projectId"?: string; "target"?: string; "to"?: number; "users"?: string; "since"?: number; "until"?: number; "state"?: string; "rollbackCandidate"?: boolean; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v6/deployments", { params });
}
/** List Deployment Files */
listDeploymentFiles(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v6/deployments/{id}/files", { params });
}
/** Get Deployment File Contents */
getDeploymentFileContents(params: { "id": string; "fileId": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v6/deployments/{id}/files/{fileId}", { params });
}
/** Remove a domain by name */
deleteDomain(params: { "domain": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v6/domains/{domain}", { params });
}
/** Get a Domain's configuration */
getDomainConfig(params: { "domain": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v6/domains/{domain}/config", { params });
}
/** Issue a new cert */
issueCert(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("POST", "/v7/certs", { body, params });
}
/** Upload a cert */
uploadCert(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("PUT", "/v7/certs", { body, params });
}
/** Get cert by id */
getCertById(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v7/certs/{id}", { params });
}
/** Remove cert */
removeCert(params: { "id": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v7/certs/{id}", { params });
}
/** Query information about an artifact */
artifactQuery(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("POST", "/v8/artifacts", { body, params });
}
/** Record an artifacts cache usage event */
recordEvents(body: unknown, params: { "x-artifact-client-ci"?: string; "x-artifact-client-interactive"?: number; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v8/artifacts/events", { body, params });
}
/** Get status of Remote Caching for this principal */
status(params: { "teamId"?: string }): Promise<any> {
return this._request("GET", "/v8/artifacts/status", { params });
}
/** Download a cache artifact */
downloadArtifact(params: { "hash": string; "x-artifact-client-ci"?: string; "x-artifact-client-interactive"?: number; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v8/artifacts/{hash}", { params });
}
/** Upload a cache artifact */
uploadArtifact(params: { "Content-Length": number; "hash": string; "x-artifact-duration"?: number; "x-artifact-client-ci"?: string; "x-artifact-client-interactive"?: number; "x-artifact-tag"?: string; "teamId"?: string }): Promise<any> {
return this._request("PUT", "/v8/artifacts/{hash}", { params });
}
/** Retrieve a list of projects */
getProjects(params: { "from"?: string; "gitForkProtection"?: string; "limit"?: string; "search"?: string; "repo"?: string; "repoId"?: string; "repoUrl"?: string; "excludeRepos"?: string; "edgeConfigId"?: string; "edgeConfigTokenId"?: string; "connectConfigurationId"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v9/projects", { params });
}
/** Create a new project */
createProject(body: unknown, params: { "teamId"?: string }): Promise<any> {
return this._request("POST", "/v9/projects", { body, params });
}
/** Find a project by id or name */
getProject(params: { "idOrName": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v9/projects/{idOrName}", { params });
}
/** Update an existing project */
updateProject(body: unknown, params: { "idOrName": string; "teamId"?: string }): Promise<any> {
return this._request("PATCH", "/v9/projects/{idOrName}", { body, params });
}
/** Delete a Project */
deleteProject(params: { "idOrName": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v9/projects/{idOrName}", { params });
}
/** Retrieve project domains by project by id or name */
getProjectDomains(params: { "idOrName": string; "production"?: string; "gitBranch"?: string; "redirects"?: string; "redirect"?: string; "verified"?: string; "limit"?: number; "since"?: number; "until"?: number; "order"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v9/projects/{idOrName}/domains", { params });
}
/** Add a domain to a project */
addProjectDomain(body: unknown, params: { "idOrName": string; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v9/projects/{idOrName}/domains", { body, params });
}
/** Get a project domain */
getProjectDomain(params: { "idOrName": string; "domain": string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v9/projects/{idOrName}/domains/{domain}", { params });
}
/** Update a project domain */
updateProjectDomain(body: unknown, params: { "idOrName": string; "domain": string; "teamId"?: string }): Promise<any> {
return this._request("PATCH", "/v9/projects/{idOrName}/domains/{domain}", { body, params });
}
/** Remove a domain from a project */
removeProjectDomain(params: { "idOrName": string; "domain": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v9/projects/{idOrName}/domains/{domain}", { params });
}
/** Verify project domain */
verifyProjectDomain(params: { "idOrName": string; "domain": string; "teamId"?: string }): Promise<any> {
return this._request("POST", "/v9/projects/{idOrName}/domains/{domain}/verify", { params });
}
/** Retrieve the environment variables of a project by id or name */
filterProjectEnvs(params: { "idOrName": string; "gitBranch"?: string; "decrypt"?: string; "source"?: string; "teamId"?: string }): Promise<any> {
return this._request("GET", "/v9/projects/{idOrName}/env", { params });
}
/** Edit an environment variable */
editProjectEnv(body: unknown, params: { "idOrName": string; "id": string; "teamId"?: string }): Promise<any> {
return this._request("PATCH", "/v9/projects/{idOrName}/env/{id}", { body, params });
}
/** Remove an environment variable */
removeProjectEnv(params: { "idOrName": string; "id": string; "teamId"?: string }): Promise<any> {
return this._request("DELETE", "/v9/projects/{idOrName}/env/{id}", { params });
}
}
export default VercelAPI;
No reviews yet. Be the first to rate this API.
Yes. Vercel API uses bearer authentication, so you bring your own key from the provider. You store it once on OmniStream and the proxy injects it into every call, so your code only ever sends your Omni key.
Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work. It exposes 112 endpoints over GET, POST, PUT, DELETE, PATCH, including GET /edge-config, POST /edge-config, GET /edge-config/{edgeConfigId}.
Install the OmniStream SDK for your language and call Vercel API through it. The client is generated from this API's OpenAPI spec, so parameters and responses are fully typed, and the same client also calls every other API in the marketplace.
You can start on the free plan. OmniStream charges for the unified SDK, key storage and proxy rather than for Vercel API itself, and Vercel API's own rate limits still apply to your provider key.
QuickChart: An API to generate charts and QR codes using QuickChart services.
Get Edge Config items
Update Edge Config items in batch
Create an Edge Config token
Get Edge Config token meta data
Get all tokens of an Edge Config
Delete one or more Edge Config tokens
Login with email
Verify a login request to get an authentication token
Retrieve a list of all checks
Creates a new Check
Get a single check
Update a check
Rerequest a check
Update an existing DNS record
Retrieve an integration configuration
Delete an integration configuration
Get configurations for the authenticated user or team
List git namespaces by provider
Deletes the Integration log drain with the provided `id`
List git repositories linked to namespace by provider
Retrieves a list of Configurable Log Drains
Creates a Configurable Log Drain
Retrieves a Configurable Log Drain
Deletes a Configurable Log Drain
Retrieve the decrypted value of an environment variable of a project by id
Create a Team
Delete a Team
Delete a Team invite code
Invite a user
Join a team
Update a Team Member
Remove a Team Member
Request access to a team
Get access request status
Delete User Account
Get a list of webhooks
Creates a webhook
Get a webhook
Deletes a webhook
Create one or more environment variables
List Deployment Builds
Cancel a deployment
Create a new deployment
Get a deployment by ID or URL
Delete a Deployment
Delete an Alias
Get deployment events
List Deployment Aliases
Assign an Alias
Create a DNS record
Delete a DNS record
Upload Deployment Files
Retrieves a list of Integration log drains
Creates a new Integration Log Drain
Delete a secret
Create a new secret
Change secret name
List all teams
Get a Team
Update a Team
List team members
Get the User
List User Events
List secrets
Get a single secret
Create an Auth Token
Delete an authentication token
List aliases
Get an Alias
Register or transfer-in a new Domain
Purchase a domain
Check the price for a domain
Check a Domain Availability
List existing DNS records
List all the domains
Get Information for a Single Domain
List Auth Tokens
Get Auth Token Metadata
List deployments
List Deployment Files
Get Deployment File Contents
Remove a domain by name
Get a Domain's configuration
Issue a new cert
Upload a cert
Get cert by id
Remove cert
Query information about an artifact
Record an artifacts cache usage event
Get status of Remote Caching for this principal
Download a cache artifact
Upload a cache artifact
Retrieve a list of projects
Create a new project
Find a project by id or name
Update an existing project
Delete a Project
Retrieve project domains by project by id or name
Add a domain to a project
Get a project domain
Update a project domain
Remove a domain from a project
Verify project domain
Retrieve the environment variables of a project by id or name
Edit an environment variable
Remove an environment variable