DOCSEARCHbyAlgolia
Submit Docs

Vercel SDK

repository·main·Indexed 41 days ago

https://github.com/vercel/sdk

A type-safe TypeScript SDK version 1.28.35 that provides programmatic control over the Vercel platform by wrapping the Vercel REST API. It includes the Vercel class for standard usage and VercelCore with standalone functions for optimized tree-shaking, featuring comprehensive operations for managing AccessGroups, projects, and members.

Tokens
318.8K
Snippets
752
Records
1.1K
Agent score
49%

What's inside Vercel SDK

  1. Overview of ChecksV2 operations

    main

    The ChecksV2 namespace in the Vercel SDK provides operations to manage and inspect checks and check runs for projects and deployments.

    Available operations include:

    • listProjectChecks: List all checks for a project
    • createProjectCheck: Create a check
    • getProjectCheck: Get a check
    • updateProjectCheck: Update a check
    • deleteProjectCheck: Delete a check
    • listCheckRuns: List runs for a check
    • listDeploymentCheckRuns: List check runs for a deployment
    • createDeploymentCheckRun: Create a check run
    • getDeploymentCheckRun: Get a check run
    • updateDeploymentCheckRun: Update a check run

  3. Manage Shared Environment Variables

    main

    The environment namespace in the Vercel SDK allows you to manage shared environment variables for a team and custom environments for projects.

    Available Operations:

    • createSharedEnvVariable: Create one or more shared environment variables.
    • listSharedEnvVariable: List all Shared Environment Variables for a team.
    • updateSharedEnvVariable: Update one or more shared environment variables.
    • deleteSharedEnvVariable: Delete one or more environment variables.
    • getSharedEnvVar: Retrieve the decrypted value of a Shared Environment Variable by ID.
    • unlinkSharedEnvVariable: Disconnect a shared environment variable from a specific project.
    • createCustomEnvironment: Create a custom environment for the current project.
    • getProjectsByIdOrNameCustomEnvironments: Retrieve custom environments for projects.
    • getCustomEnvironment: Retrieve a specific custom environment.
    • updateCustomEnvironment: Update a custom environment.
    • removeCustomEnvironment: Remove a custom environment.

  4. Available Rolling Release operations

    main

    The Rolling Release SDK provides several operations to manage project deployment cycles and configurations:

    • getRollingReleaseBillingStatus: Get rolling release billing status.
    • getRollingReleaseConfig: Get rolling release configuration.
    • deleteRollingReleaseConfig: Delete rolling release configuration.
    • updateRollingReleaseConfig: Update the rolling release settings for the project.
    • getRollingRelease: Get the active rolling release information for a project.
    • approveRollingReleaseStage: Update the active rolling release to the next stage for a project.
    • startRollingRelease: Start a rolling release for the project.
    • completeRollingRelease: Complete the rolling release for the project.

  5. Available Sandbox Operations

    main

    The Sandboxes API provides a suite of operations for managing sandboxes, drives, sessions, and snapshots.

    Core Operations:

    • Sandboxes: listNamedSandboxes, getNamedSandbox, deleteSandbox.
    • Drives: listDrives, getOrCreateDrive, deleteDrive.
    • Sessions: listSessions, getSession, stopSession, extendSessionTimeout, updateSessionNetworkPolicy, readSessionFile, createSessionDirectory, writeSessionFiles.
    • Snapshots: listSessionSnapshots, getSessionSnapshot, deleteSessionSnapshot, createSandboxesSessionsBySessionIdSnapshotV2, createSandboxesSessionsBySessionIdSnapshotV3.
    • Commands: listSessionCommands, getSessionCommand, killSessionCommand.

  6. Available operations in DomainsRegistrar

    main

    The DomainsRegistrar namespace in the Vercel SDK provides a comprehensive suite of operations for managing domain registrations, including checking availability, pricing, purchasing, transferring, and managing existing domains.

    Key capabilities include:

    • Discovery: getSupportedTlds, getTld, getTldPrice.
    • Availability & Pricing: getDomainAvailability, getDomainPrice, getBulkPrice, getBulkAvailability, searchDomains.
    • Purchasing & Transfers: buySingleDomain, buyDomains, transferInDomain, getDomainTransferIn.
    • Management: renewDomain, updateDomainAutoRenew, updateDomainNameservers, getDomainContactVerification, getDomainAuthCode.
    • Orders & Schema: getOrder, getContactInfoSchema.

  7. Available Log Drain operations

    main

    The LogDrains namespace provides several operations for managing log drains. Note that many of these operations are marked as deprecated:

    • getConfigurableLogDrain: Retrieves a Configurable Log Drain.
    • deleteConfigurableLogDrain: Deletes a Configurable Log Drain.
    • getAllLogDrains: Retrieves a list of all Log Drains.
    • createConfigurableLogDrain: Creates a Configurable Log Drain.
    • getIntegrationLogDrains: Retrieves a list of Integration log drains.
    • createLogDrain: Creates a new Integration Log Drain.
    • deleteIntegrationLogDrain: Deletes an Integration log drain by id.

  8. Manage Domains with @vercel/sdk

    main

    The Domains module in the Vercel SDK allows you to manage domain configurations, verification records, and ownership on the Vercel platform.

    Available operations include:

    • getDomainConfig: Get a Domain's configuration
    • getDomainVerificationRecord: Get Domain Verification Record
    • claimDomainOwnership: Claim Domain Ownership
    • getDomainProjectDomains: List Project Domains by Apex Domain
    • getDomain: Get Information for a Single Domain
    • getDomains: List all the domains
    • createOrTransferDomain: Add an existing domain to the Vercel platform
    • patchDomain: Update or move apex domain
    • deleteDomain: Remove a domain by name

  9. Available Marketplace Operations

    main

    The Marketplace namespace in the Vercel SDK provides a wide range of operations for managing integrations, resources, and account information. Key operations include:

    • Installation Management: updateInstallation, finalizeInstallation, rotateInstallationCredential, revokeInstallationCredential.
    • Account & Member Info: getAccountInfo, getMember.
    • Resource Management: getIntegrationResources, getIntegrationResource, deleteIntegrationResource, importResource, updateResource, updateResourceSecretsById.
    • Billing & Invoices: submitBillingData, submitInvoice, getInvoice, updateInvoice, submitPrepaymentBalances.
    • Configuration & Experimentation: createInstallationIntegrationConfiguration, updateInstallationIntegrationConfiguration, deleteInstallationIntegrationConfiguration.
    • SSO: exchangeSsoToken.

    Note: updateResourceSecrets is deprecated.

  10. Available AccessGroup operations

    main

    The AccessGroups resource provides several operations for managing access groups and their associated projects and members:

    • createAccessGroup: Creates an access group
    • readAccessGroup: Reads an access group
    • updateAccessGroup: Updates an access group
    • deleteAccessGroup: Deletes an access group
    • listAccessGroups: Lists access groups for a team, project, or member
    • listAccessGroupMembers: Lists members of an access group
    • listAccessGroupProjects: Lists projects of an access group
    • createAccessGroupProject: Creates an access group project
    • readAccessGroupProject: Reads an access group project
    • updateAccessGroupProject: Updates an access group project
    • deleteAccessGroupProject: Deletes an access group project

  11. Available operations for BulkRedirects

    main

    The BulkRedirects namespace in the Vercel SDK provides several operations for managing project-level redirects:

    • stageRedirects: Stages new redirects for a project and returns a new version.
    • getRedirects: Retrieves existing project-level redirects.
    • deleteRedirects: Deletes project-level redirects.
    • editRedirect: Edits a specific project-level redirect.
    • restoreRedirects: Restores staged project-level redirects to their production version.
    • getVersions: Retrieves the version history for a project's redirects.
    • updateVersion: Promotes a staging version to production or restores a previous production version.

  12. Available Project operations in @vercel/sdk

    main

    The @vercel/sdk provides a comprehensive set of operations for managing Vercel projects. These include retrieving project lists, managing domains, handling environment variables, controlling deployments (rollbacks and promotions), and managing project transfers.

    ### Available Operations

* getProjects - Retrieve a list of projects
* getProjectTrace - Get a project trace by request ID
* createProject - Create a new project
* getProjectToken - Generate a project OIDC token
* createTraceSession - Create a trace session token for a deployment
* getProject - Find a project by id or name
* updateProject - Update an existing project
* deleteProject - Delete a Project
* uploadProjectAvatar - Upload a project avatar
* getProjectDomains - Retrieve project domains by project by id or name
* getProjectDomain - Get a project domain
* updateProjectDomain - Update a project domain
* removeProjectDomain - Remove a domain from a project
* addProjectDomain - Add a domain to a project
* moveProjectDomain - Move a project domain
* verifyProjectDomain - Verify project domain
* filterProjectEnvs - Retrieve the environment variables of a project by id or name
* createProjectEnv - Create one or more environment variables
* getProjectEnv - Retrieve the decrypted value of an environment variable of a project by id
* removeProjectEnv - Remove an environment variable
* editProjectEnv - Edit an environment variable
* batchRemoveProjectEnv - Batch remove environment variables
* createProjectTransferRequest - Create project transfer request
* acceptProjectTransferRequest - Accept project transfer request
* updateProjectProtectionBypass - Update Protection Bypass for Automation
* requestRollback - Point production traffic to a previous production deployment by ID
* updateProjectsByProjectIdRollbackByDeploymentIdUpdateDescription - Updates the description for a rollback
* updateMicrofrontends - Update the microfrontends settings
* requestPromote - Point production traffic to a given deployment
* listPromoteAliases - Gets a list of aliases with status for the current promote
* pauseProject - Pause a project
* unpauseProject - Unpause a project