Skip to content

Latest commit

 

History

History
56 lines (51 loc) · 4.12 KB

createdeploymentrequest.md

File metadata and controls

56 lines (51 loc) · 4.12 KB

CreateDeploymentRequest

Example Usage

import { CreateDeploymentRequest } from "@vercel/sdk/models/createdeploymentop.js";

let value: CreateDeploymentRequest = {
  teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
  slug: "my-team-url-slug",
  requestBody: {
    deploymentId: "dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6",
    files: [
      {
        data: "<value>",
        file: "folder/file.js",
      },
    ],
    gitMetadata: {
      remoteUrl: "https://github.com/vercel/next.js",
      commitAuthorName: "kyliau",
      commitMessage:
        "add method to measure Interaction to Next Paint (INP) (#36490)",
      commitRef: "main",
      commitSha: "dc36199b2234c6586ebe05ec94078a895c707e29",
      dirty: true,
    },
    gitSource: {
      owner: "bitbucket_user",
      ref: "main",
      sha: "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
      slug: "my-awesome-project",
      type: "bitbucket",
    },
    meta: {
      "foo": "bar",
    },
    name: "my-instant-deployment",
    project: "my-deployment-project",
    projectSettings: {
      buildCommand: "next build",
      installCommand: "pnpm install",
    },
  },
};

Fields

Field Type Required Description Example
forceNew models.ForceNew ➖ Forces a new deployment even if there is a previous similar deployment
skipAutoDetectionConfirmation models.SkipAutoDetectionConfirmation ➖ Allows to skip framework detection so the API would not fail to ask for confirmation
teamId string ➖ The Team identifier to perform the request on behalf of. team_1a2b3c4d5e6f7g8h9i0j1k2l
slug string ➖ The Team slug to perform the request on behalf of. my-team-url-slug
requestBody models.CreateDeploymentRequestBody ✔️ N/A