Skip to content

Latest commit

 

History

History
38 lines (33 loc) · 8.64 KB

getdeploymentsrequest.md

File metadata and controls

38 lines (33 loc) · 8.64 KB
Raw

GetDeploymentsRequest

Example Usage

import { GetDeploymentsRequest } from "@vercel/sdk/models/operations/getdeployments.js";

let value: GetDeploymentsRequest = {
  app: "docs",
  from: 1612948664566,
  limit: 10,
  projectId: "QmXGTs7mvAMMC7WW5ebrM33qKG32QK3h4vmQMjmY",
  target: "production",
  to: 1612948664566,
  users: "kr1PsOIzqEL5Xg6M4VZcZosf,K4amb7K9dAt5R2vBJWF32bmY",
  since: 1540095775941,
  until: 1540095775951,
  state: "BUILDING,READY",
};

Fields

Field Type Required Description Example
app string ➖ Name of the deployment. docs
from number ➖ Gets the deployment created after this Date timestamp. (default: current time) 1612948664566
limit number ➖ Maximum number of deployments to list from a request. 10
projectId string ➖ Filter deployments from the given ID or name. QmXGTs7mvAMMC7WW5ebrM33qKG32QK3h4vmQMjmY
target string ➖ Filter deployments based on the environment. production
to number ➖ Gets the deployment created before this Date timestamp. (default: current time) 1612948664566
users string ➖ Filter out deployments based on users who have created the deployment. kr1PsOIzqEL5Xg6M4VZcZosf,K4amb7K9dAt5R2vBJWF32bmY
since number ➖ Get Deployments created after this JavaScript timestamp. 1540095775941
until number ➖ Get Deployments created before this JavaScript timestamp. 1540095775951
state string ➖ Filter deployments based on their state (BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED) BUILDING,READY
rollbackCandidate boolean ➖ Filter deployments based on their rollback candidacy
teamId string ➖ The Team identifier to perform the request on behalf of.
slug string ➖ The Team slug to perform the request on behalf of.